Autenticação

Visão Geral

Escolha a API que melhor se adapta ao seu caso de uso:

Dados da API

• Dados da API Gateway:
  • URL: https://api.sopague.com.br/gateway
  • Arquitetura: Representational State Transfer (REST)

---

• Dados das outras API:
  • URL: https://integration.enoqbank.com/enoq
  • Arquitetura: Representational State Transfer (REST)

Este método é utilizado para obter um token de autenticação, necessário para executar outros métodos da API.

Pré-requisitos

Para acessar a API, é necessário fornecer:

• CNPJ da empresa que realizará as transações;
• Razão Social da empresa que realizará as transações;
• Dados de contato da equipe técnica responsável pela integração;
• IP do servidor de produção que realizará as solicitações.

---

Endpoint de Login

POST /api/authentication/login

Requisição

Exemplo de requisição via REST com o corpo no formato JSON:

Requisição

{
  "userName": "string",
  "password": "string"
}

Parâmetros da Requisição

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
UserName	Nome de usuário de acesso à API	String	30	Credenciais fornecidas pela Enoq
Password	Senha do usuário de acesso à API	String	256	Credenciais fornecidas pela Enoq

---

Resposta de Sucesso

🟢 200

Resposta

{
  "authenticated": true,
  "created": "2023-01-01T14:25:28.913Z",
  "expiration": "2023-01-01T14:25:28.913Z",
  "accessToken": "string",
  "message": "string"
}

Dicionário de Dados - Resposta

CAMPO	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
Authenticated	Status da autenticação	Bool	-	true para sucesso, false para falhas.
Created	Data e hora da autenticação	DateTime	-	Indica o momento da autenticação.
Expiration	Data e hora da expiração da sessão	DateTime	-	Após expirar, um novo token será necessário.
AccessToken	Token de autenticação	String	-	Utilizado como autenticador nas chamadas da API.

---

Header de Autenticação

Em todas as chamadas à API (exceto para obtenção do token), é necessário incluir o seguinte header:

Key	Value
Authorization	Bearer eyJhbGciOiJSUzIlxdWVtZS[...]mj2m65fJfvmjdVXp6dQ

Detalhes

• O tipo de autenticação Bearer nunca muda.
• O valor do token (exemplo: eyJhbGciOiJSUzIlxdWVtZS[...]mj2m65fJfvmjdVXp6dQ) é obtido pelo método POST /api/authentication/login.

---

Observações Importantes

Atenção

• Tokens têm prazo de validade. É responsabilidade do sistema integrador renovar o token antes de sua expiração para continuar realizando chamadas.