Passo a passo

Este guia oferece uma visão geral passo a passo para integrar-se aos serviços da Unico IDCloud, abordando autenticação, uso do SDK, chamadas de serviço, configuração de webhook e muito mais.

Passo 1: Definir o uso de capacidades

Defina quais capacidades do produto serão necessárias para sua operação.

• Leia mais em capacidades.

Passo 2: Definir o meio de integração

Defina se a integração será realizada através do by Unico ou by Client e mapeie os pontos de comunicação necessários (APIs, SDKs, webhooks, callbacks, etc).

• Leia mais em by Unico vs by Client.

Passo 3: Autenticar e obter o access-token

Com suas credenciais, você deve se autenticar e obter um token de acesso OAuth2. Este token é necessário para todas as solicitações de API.

• Leia mais na seção "Autenticação" do meio de integração escolhido.

Passo 4: Implementar SDK ou Redirect (se aplicável)

Caso utilize nossos SDKs ou Redirect, implemente os métodos respectivos.

• Leia mais em SDK by Client OU SDK/Redirect by Unico.

Passo 5: Implementar webhook (se aplicável)

Se a integração exigir notificações assíncronas, (1) configure o endpoint receptor no seu servidor, (2) implemente a autenticação (Basic Auth, APIKey, OAuth2 e/ou restrição de IPs), (3) garanta que o processamento seja idempotente, evitando duplicidade, e por fim, (4) tenha sempre um fallback em casos de erros nos serviços.

• Leia mais na seção "Webhooks" do meio de integração escolhido.

Passo 6: Implementar chamadas do serviço

Implemente as chamadas necessárias para o consumo dos serviços. (1) Todas as requisições devem ser feitas server-to-server via HTTPS (TLS 1.2+) e (2) trate respostas de erro (4xx, 5xx) de forma consistente.

• Leia mais em by Unico OU by Client.

Recomendações & Boas Práticas

Utilize HTTPS/TLS em todas as comunicações.
As requisições devem ser sempre server-to-server, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.
Prefira webhooks para receber resultado final, evitando polling contínuo.
Se optar pelo polling em vez do webhook, implemente um backoff exponencial com jitter. (O backoff exponencial aumenta progressivamente o tempo de espera entre as tentativas).
Não confie em polling fixo — o tempo de processamento pode variar.
Use SDKs oficiais para simplificar captura e envio de dados no cliente.
Valide erros rapidamente — monitore casos de erro e trate falhas (timeout, invalidação de dados).

Próximos passos

• Explore as capacidades disponíveis.

• Revise as diferenças entre os meios de integração by Unico vs by Client.