O que é
Você pode obter o resultado de uma consulta através da URL de callback, que você informa no momento da requisição, ou fazendo uma requisição de forma manual, como será descrito nesse artigo.
Sobre a requisição:
Método: GET
URL: https://api.plexi.com.brEndereço: URL Base + /api/maestro/result/{requestId}
{requestId} é o ID recebido na resposta da primeira requisição.
URL Base:
Include Page | ||||
---|---|---|---|---|
|
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Parâmetros da URL
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
requestId | String | Sim | String ID da requisição que se deseja consultar. É o mesmo ID retornado na resposta da primeira requisição. |
Estrutura da resposta
Status | Significado | Descrição |
---|---|---|
202 | Accepted | Resultado em processamento |
404 | Not Found | requestId não existe ou consulta já está expirada |
520 | Unknown | Todas as tentativas de criar um resultado falharam e não haverá mais tentativa |
200 | Ok | Resultado retornado com sucesso |
Exemplos de respostas
Status 200
Code Block |
---|
{ "endpoint":"trf1-certidao-distribuicao", "status":"negativa", "pdf":"JVBERi0xLjQKMSAwIG9iago8P..." } |
...