​
Roteiro de integração

Use este roteiro como checklist de execução. A ideia é sair de uma primeira chamada manual, validar o comportamento esperado e só depois levar o fluxo para o código da aplicação.
1

Confirme o ambiente

Escolha onde o teste será feito:A estrutura da chamada é a mesma nos dois ambientes. Para trocar de HML para produção, altere apenas a base URL.
2

Gere o token

Antes de executar serviços protegidos, gere um token JWT.
Copie o valor de access_token retornado. Nas chamadas seguintes, envie:
3

Teste manualmente antes de codar

Se a pessoa integrando ainda não tem familiaridade com terminal, comece pelo Postman. Ele deixa URL, headers e body separados, o que reduz erro de digitação.Fluxo recomendado:
  1. testar no Postman;
  2. repetir o mesmo request com curl;
  3. confirmar o response esperado;
  4. levar o request para Node.js, Python, C# ou outra linguagem.
4

Escolha o serviço correto

O endpoint POST /api/service-api funciona como executor de produtos. A rota é sempre a mesma, mas o campo service define o que será executado.
Para pessoa física, a entrada principal costuma ser cpf. Para pessoa jurídica, costuma ser cnpj. Serviços de documento, biometria e documentoscopia podem exigir imagens em base64, URLs de imagem, selfie ou chave de consulta.
5

Valide o response

Na maioria dos serviços, os dados de negócio ficam em result e o status técnico fica em status.
Não valide apenas o HTTP status. Leia também status.code, status.message e, quando existir, externalId.
6

Prepare a integração para produção

Antes de subir para produção, confirme:
  1. credenciais de produção foram liberadas;
  2. a base URL foi trocada para https://backoffice.idcerberus.com;
  3. token expirado é tratado gerando um novo token;
  4. erros 400, 401 e 403 têm tratamento claro;
  5. logs registram service, documento consultado de forma segura, status.code, status.message e externalId, quando retornado;
  6. dados sensíveis, base64 e tokens não são gravados em log aberto.

​
Onboarding? Configure webhook em vez de só consultar

Se o seu fluxo é de onboarding (SDK ou Cliente Web), não fique só no polling do passo anterior. Configure um webhook para ser avisado automaticamente quando o status mudar. Veja Webhooks. Isso vale tanto para HML (testar o recebimento) quanto para produção.

​
Onde continuar

  1. Para primeira chamada completa: Quickstart
  2. Para escolher produtos: Escolha o serviço certo
  3. Para ver todos os grupos de serviço: Matriz de serviços
  4. Para onboarding via SDK: Onboarding via SDK
  5. Para contrato técnico: API Reference