Pular para o conteúdo principal
Este guia leva você das credenciais até sua primeira chamada de API bem-sucedida.

Pré-requisitos

  • Um cliente de API do Portão 3. Seu gerente de conta fornece as credenciais do cliente de API (client_id / client_secret).
  • Seu realmId e organizationId, compartilhados durante o onboarding. Endpoints com escopo de tenant exigem ambos no caminho.

Passo 1: Obtenha um token de acesso

Autentique-se no serviço Identity com as credenciais do seu cliente de API. Envie seu client_id e client_secret como credenciais HTTP Basic e defina grantType como client_credentials no corpo:
Um login bem-sucedido retorna seus tokens:
Use o accessToken como seu token bearer em cada requisição à API.

Passo 2: Faça sua primeira chamada

Verifique o token buscando a identidade à qual ele pertence:
Uma resposta 200 confirma que seu token funciona.

Passo 3: Chame um endpoint com escopo de tenant

A maioria dos endpoints tem escopo do seu realm e organização. Por exemplo, liste suas negociações de cobrança:
Se receber um 403, verifique se o realmId e o organizationId no caminho correspondem ao tenant ao qual suas credenciais pertencem.

Passo 4: Renove seu token

Os tokens de acesso têm vida curta. Quando um expira, solicite um novo repetindo o Passo 1 com as credenciais do seu cliente de API.

Próximos passos

Explore a Referência da API

Todos os endpoints em todos os serviços do Portão 3, com esquemas e exemplos.

Obtenha suporte

Dúvidas sobre credenciais, tenancy ou um endpoint específico? Podemos ajudar.
Travou? Envie um e-mail para suporte@portao3.com.br e inclua o traceId de qualquer resposta de erro.