Autenticação
A API utiliza HTTP Basic Authentication em ambos os ambientes.
Como obter as credenciais
Ambiente de Homologação (Sandbox)
- Acesse o Portal Developers
- Inicie a jornada Equals Connect
- Na seção "Ambiente de homologação", abra a modal "Dados do ambiente de homologação"
- Copie:
- Usuário do portal de homologação (email)
- Token (gerado automaticamente)
Ambiente de Produção
- Acesse o Portal Equals
- Navegue até
Administração > Tokens de API - Clique em "Novo Token"
- Informe um nome e anote o token gerado (ele será exibido somente uma vez)
- Use seu email de login do portal Equals como usuário
Resumo por Ambiente
| Ambiente | Email (Usuário) | Token | Obtido em |
|---|---|---|---|
| Sandbox | Exibido na modal "Dados do ambiente de homologação" | Exibido na mesma modal | Portal Developers |
| Produção | Seu email de login do Equals | Gerado em Administração > Tokens de API | Portal Equals |
Como autenticar
Combine seu Email e Token no formato:
Authorization: Basic base64(email:token)
Exemplo de Header
Authorization: Basic dXN1YXJpb0Bkb21pbmlvLmNvbTpUb2tlbkRlRXhlbXBsbzEyMw==
Geração do Header (Node.js)
const email = "usuario@dominio.com";
const token = "seu_token_aqui";
const credentials = `${email}:${token}`;
const encoded = Buffer.from(credentials).toString("base64");
const authHeader = `Basic ${encoded}`;
[!IMPORTANT]
Em homologação, o token é gerado automaticamente e pode ser consultado novamente na modal.
Nunca compartilhe seu Token. Ele deve ser armazenado de forma segura no backend da sua aplicação.
Este conteúdo foi útil para você?