Lista de endpoints

Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Quais são os requisitos para a utilização desta API?

Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
- Integração Direta: Ter finalizado a etapa de autorização
- Parceria Cora: Já ter feito a etapa de autorização e autenticação

Qual token de acesso devo utilizar?

Se você é um parceiro e precisa listar todos os endpoints ligados à sua aplicação, é recomendável utilizar um token do tipo "client credentials", que geralmente oferece acesso a todos os endpoints da API. Por outro lado, se você deseja listar os endpoints de uma conta específica, é recomendável utilizar um token do tipo "authorization_code".

Parâmetros da resposta

Parâmetro	Tipo	Descrição
id obrigatório	String	Identificador do endpoint criado. Esse id pode ser utilizado na exclusão de endpoints
url obrigatório	String	Endpoint, ou endereço URL para o qual as notificações serão enviadas
resource obrigatório	String	Recurso escolhido no momento da criação do endpoint, indica o serviço que será associado ao gatilho
trigger obrigatório	String	Gatilho definido ao criar o endpoint, indica o que ocasionará o envio da notificação
connectionTimeout obrigatório	Int	Tempo limite de conexão permitido antes que ocorra um erro de tempo limite
readTimeout obrigatório	Int	Tempo limite de leitura antes que ocorra um erro de tempo limite
includeResource obrigatório	Boolean	false
expandable obrigatório	Boolean	false
active obrigatório	Boolean	Indica se o endpoint está ativo ou não. No momento da criação, será definido como true

Dicas de implementação

Premissas

É fundamental que o token correto seja utilizado para que a resposta indique os endpoints desejados. Este é um ponto de atenção importante na integração de Parceria Cora, que irá lidar com diferentes tipos de token de autenticação.

Erros Comuns

Código de erro	Descrição
401 (Unauthorized)	O token de acesso está inválido ou expirado. Erro comum no momento de trocas de ambientes (Stage/Production).
400 (Bad Request)	Requisição mal formatada. Uma possibilidade é a presença de campos com algum erro de digitação.

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.