Autenticação Gestão do Banco

Esse endpoint realiza a autenticação do usuário no ambiente de backoffice, permitindo o acesso às rotas de gerenciamento do banco, como:

Cadastro de Webhook
Consulta de Contas
Consulta de dados do Onboarding
Listagem de transações
Entre outros recursos administrativos

Pré-requisitos

Para utilizar este endpoint, é necessário que o usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Backoffice/Login

--request POST 'https://sandbox.hiperbanco.com.br/Backoffice/Login' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--data-raw '{
	"email": "[email protected]",
	"password": "Senhatest123@",
	"client_id": "0a50a787-5ec5-4120-a34e-3485f7d98c8b"
}'

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`email`	string	Endereço de e-mail do usuário
`password`	string	Senha de acesso
`client_id`	string	Identificador único do cliente (UUID)

{
	"email": "[email protected]",
	"password": "Senhatest123@",
	"client_id": "0a50a787-5ec5-4120-a34e-3485f7d98c8b"
}

Resposta (Response)

O status code 201 indicará sucesso na requisição.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`status`	number	Código de status HTTP da requisição
`access_token`	string	Token de acesso JWT utilizado para autenticação
`name`	string	Nome do usuário autenticado

{
  "status": 200,
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjM1Y2M3NTg0LTc5YjAtNDcwMy1hNjQwLWFmNTZiNzhmM2I4MiIsImVtYWlsIjoiam9zZUBleGVtcGxvLmNvbSIsImlkIjoiZDA4MGEzMjAtY2I5Zi00YTRlLTk2ODAtZDNkNjY4Y2FjNmI3IiwiaW5zdGFuY2VJZCI6IjNhNDkzYjE0LTg0ZDgtNDkxOC05NjFiLTQ3M2Y1ZDYyOGZlMCIsIm5hbWUiOiJKb3PDqSBNYXJxdWVzIiwiaWF0IjoxNzUzODQyODUzLCJleHAiOjE3NTM4NDQ2NTN9.0fZiUpVj5HxC-_T3jD9DgYxsTYR8E7jhK3mG9ZVO7ZY",
  "name": "José Marques"
}

Erros

Em caso de falha na autenticação, a resposta trará o seguinte campo no corpo da requisição, em formato JSON:

{
    "status": 400,
    "data": "client_id, e-mail, senha ou código incorretos."
}