Pular para o conteúdo principal

Autenticação

A API utiliza HTTP Basic Authentication em ambos os ambientes.

Como obter as credenciais

Ambiente de Homologação (Sandbox)

  1. Acesse o Portal Developers
  2. Inicie a jornada Equals Connect
  3. Na seção "Ambiente de homologação", abra a modal "Dados do ambiente de homologação"
  4. Copie:
    • Usuário do portal de homologação (email)
    • Token (gerado automaticamente)

Ambiente de Produção

  1. Acesse o Portal Equals
  2. Navegue até Administração > Tokens de API
  3. Clique em "Novo Token"
  4. Informe um nome e anote o token gerado (ele será exibido somente uma vez)
  5. Use seu email de login do portal Equals como usuário

Resumo por Ambiente

AmbienteEmail (Usuário)TokenObtido em
SandboxExibido na modal "Dados do ambiente de homologação"Exibido na mesma modalPortal Developers
ProduçãoSeu email de login do EqualsGerado em Administração > Tokens de APIPortal 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ê?