Pular para o conteúdo principal

Guia da API

A API REST oferece uma integração simples e rápida ao gerenciar os processos. A API utiliza requisições e respostas no formato JSON e possui um sistema de autenticação baseado em JWT Bearer.

Principais funcionalidades​

Através da API você gerencia todo o fluxo de um processo. Abaixo uma lista com as principais funcionalidades da API.

  • Criar um novo processo
  • Obter o resultado do processo
Ambientes

Você pode utilizar a API em um ambiente de homologação para testar as funcionalidades evitando afetar seu entorno produtivo.

  • Ambiente de homologação:
    • https://api.cadastro.uat.unico.app/client/v1
    • https://sign-core-uat.acesso.io/api/v1
  • Ambiente de produção:
    • https://api.cadastro.unico.app/client/v1
    • https://sign.acesso.io/api/v1

O processo de integração é realizado através de 4 passos:

1 - Criar um processo​

O seu backend chama a API para criar um processo, nesse passo é necessário obter um token de autenticação, veja mais detalhes em Autenticação.

curl -X 'POST' \
  'https://api.cadastro.uat.unico.app/client/v1/process/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{TOKEN}}'
  -d '{
    "callbackUri": "/",
    "flow": "id",
    "person": {
        "duiType": "DUI_TYPE_BR_CPF",
        "duiValue": "73689290074"
    },
    "purpose": "creditprocess"
}'

Essas são as informações básicas para você se integrar com a plataforma, algumas jornadas específicas necessitam de informações adicionais, veja mais detalhes em Criando um processo.

2 - Redirecionar para Experiência do Cadastro by Unico​

A sua aplicação frontend redireciona para a experiência do Cadastro by Unico.

Você encontra o guia de como realizar o redirecionamento em Redirecionando o usuário.

3 - Jornada do usuário​

Através da plataforma, o usuário realiza todos os passos necessários.

4 - Obter resultado do processo​

No fim do passo 3 o usuário é redirecionado de volta para a sua experiência. Nesse momento você pode buscar o resultado, veja mais em Obtendo resultado de um processo.

curl -X 'GET' \
  'https://api.cadastro.uat.unico.app/client/v1/process/{id_processo}' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{TOKEN}}'

O Conjunto Probatório só fica disponível após a finalização do processo, veja mais em Acessar Documento e Conjunto Probatório.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.