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.

Você também pode receber os resultados via callback, conforme documentação.

Sobre a requisição

Método: GET

Endereço: https://api.plexi.com.br/api/maestro/result/{requestId}

{requestId} é o ID recebido na resposta da primeira requisição.

URL Base:

https://api.plexi.com.br/

Parâmetros do header

Nome Tipo Obrigatório? Descrição
Authorization String Sim Chave de API gerada no cadastro no Plexi, prefixada com Bearer

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
200 Ok Resultado retornado com sucesso
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; Pode ocorrer também quando o callback de resposta não retorna HTTP 200.

Exemplos de respostas

Status 200

JSON
{
  "endpoint":"trf1-certidao-distribuicao",
  "status":"negativa",
  "pdf":"JVBERi0xLjQKMSAwIG9iago8P..."
}

Os campos retornados variam em cada consulta. Veja a documentação específica da consulta para visualizar campos retornados.

Status 404

Neste caso não é retornado corpo de resposta, apenas o status.