Quickstart

Este guia mostra o caminho mais simples para fazer a primeira chamada na API idCerberus. Ele foi escrito para quem ainda não tem familiaridade com API, terminal ou curl. Você pode testar de três formas:
Se você nunca executou um curl, comece pelo Postman. Depois que a chamada funcionar, copie o mesmo padrão para o terminal ou para o código da aplicação.

Antes de começar

Você precisa ter:
  1. client e secret da sua aplicação;
  2. acesso ao ambiente de homologação ou produção;
  3. um CPF ou CNPJ de teste;
  4. permissão para consumir o produto desejado.
Ainda não tem client e secret? Esse par é liberado pela React IT junto com o produto contratado, não é algo que você gera sozinho. Solicite pelo e-mail [email protected] antes de seguir este guia.
Os endpoints base são: A chamada é a mesma nos dois ambientes. Para usar produção, mantenha método, headers e body iguais e troque apenas a URL.
Não misture ambientes. Token gerado em homologação deve ser usado com URL de homologação. Token gerado em produção deve ser usado com URL de produção.
1

Escolha onde vai testar

Postman

  1. Abra o Postman.
  2. Clique em New.
  3. Escolha HTTP Request.
  4. Selecione o método POST.
  5. Cole a URL do ambiente desejado.
  6. Vá na aba Headers e adicione Content-Type com valor application/json.
  7. Vá na aba Body.
  8. Escolha raw.
  9. Selecione JSON.
  10. Cole o body do exemplo.
  11. Clique em Send.

Windows PowerShell

  1. Abra o menu iniciar.
  2. Pesquise por PowerShell.
  3. Abra o PowerShell.
  4. Cole o comando curl.exe do exemplo.
  5. Pressione Enter.
No Windows, prefira curl.exe. O comando curl sozinho pode ser interpretado como outro comando interno do PowerShell.

Windows CMD

  1. Abra o menu iniciar.
  2. Pesquise por cmd.
  3. Abra o Prompt de Comando.
  4. Cole o comando em uma única linha ou use ^ para quebrar linhas.
  5. Pressione Enter.

macOS ou Linux

  1. Abra o Terminal.
  2. Cole o comando curl do exemplo.
  3. Pressione Enter.
Em macOS e Linux, o curl normalmente já vem instalado. Se o terminal informar que o comando não existe, instale o pacote curl pelo gerenciador do sistema.
2

Gere um token

O primeiro request gera um token JWT. Esse token será usado nas próximas chamadas protegidas.No Postman, configure assim:Body:

HML

Produção

Windows CMD

Resposta esperada:
Copie o valor de access_token. Ele será usado no próximo passo.No Postman, copie somente o conteúdo entre aspas. Exemplo:
Nesse caso, o token a ser usado no próximo passo é eyJhbGciOi....
3

Execute um serviço

Use o token retornado no header Authorization.No Postman, crie uma nova request:

HML

Produção

Windows CMD

Vai testar OCR? Use o guia OCR via Service API para montar o payload com image1, image2, documentType, base64 e exemplos de retorno. OCR precisa de imagem real; payload curto só valida autenticação e acesso.
Substitua:

Consulta CPF

Use quando quiser validar o fluxo com um service simples de pessoa física.

Consulta CNPJ

Use quando quiser validar o fluxo com um service simples de pessoa jurídica.

OCR com imagem

Use quando o body precisar de base64, imagem, URL ou documentType.

Catálogo de services

Use para navegar pelos grupos de produtos do POST /api/service-api.
4

Leia o resultado

A maior parte dos serviços retorna os dados em result e o status técnico em status.
5

Trate sucesso e falha

Use status.code para decidir o comportamento da sua aplicação.

Próximo passo

Se você já sabe qual produto consumir, vá para a API Reference. Se ainda está desenhando o fluxo, use Escolha o serviço certo.
Deu algo errado nesse teste? Não precisa adivinhar. Veja Erros comuns de integração antes de tentar de novo. A maioria dos problemas na primeira chamada é token, ambiente trocado ou campo service ausente, e todos têm solução direta lá.