Todas as respostas estão em formato JSON.

Você recebe respostas em 2 momentos:

1. Resposta à requisição da consulta - ocorre imediatamente após fazer uma requisição

2. Resposta com o resultado da consulta - informada por callback ou consultando a API de resposta do Plexi

Resposta à requisição da consulta

Há 2 tipos de respostas a uma requisição:

Status 201 - solicitação recebida

Exemplo de resposta:

O requestId é o identificador único da requisição.

Status 422 - solicitação contém erros

Exemplo de resposta:

Resposta com o resultado da consulta

Respostas a requisições que possuem URL de callback

O Plexi enviará na URL de callback o resultado da consulta assim que ele estiver pronto. Também é incluído na resposta o requestId e o endpoint, que representa o ID da consulta e o nome da consulta respectivamente.

Ao enviar a resposta, o Plexi espera um retorno com status 200. Caso isso não aconteça, uma nova tentativa de envio da resposta é feita 30 segundos após o recebimento do primeiro retorno.

Caso ocorra algum problema em sua URL, ainda assim você poderá ver o resultado, seguindo o passo da situação a seguir.

Respostas a requisições que NÃO possuem URL de callback

Caso não tenha informado uma URL de callback, você poderá consultar a API do Plexi para obter o resultado.

Veja a seção API de resultados das consultas para saber como obter o resultado de uma consulta.

Informações importantes