Consultar Analises Flash

Requisição

GET [Url Ambiente]/Flash/V2/Consultar

Header

Identificador	Valor
Accept	application/json
Authorization	Bearer [Valor do Token retornado na Autenticação]

Query

Parâmetro	Descrição	Tipo	Exemplos
Chave	Campo para identificação da requisição	String	"ChaveDefinidaPeloCliente"

Exemplo

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer ababab1236-nbahdj-25' 'https://api.plataformaacertpix.com.br/Flash/Consultar?chave=aababab1236-ababab-5263'

Status Code 200

Retorno de sucesso.

Com acesso ao token e chave, será possível obter o retorno/consulta da análise. Segue campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	String	'0' ou '1'
Mensagens	Descrição do status da requisição	String	"SUCESSO" ou "NÃO ENCONTRADO"
Status	Status da Análise	String	Tabela
IdAnalise	ID da Análise (número interno AcertPix)	Int	1000
Chave	Campo chave da análise	String	“12121212abc”
DataCadastro	Data de cadastro da análise	DataTime	2022-01-01T11:50:51
DataFinalizado	Data de envio da resposta	DataTime	2022-01-01T11:50:51
Result	Resultado da análise	String	O Resultado é variável, dependendo do cadastro da empresa e do tipo de documento enviado

Exemplo

{
  "Status": 0,
  "Mensagens": [
    "SUCESSO"
  ],
  "Analise": {
    "Status": 10,
    "IdAnalise": 1000,
    "Chave": "12121212abc",
    "DataCadastro": 2022-01-01T11:50:51,
    "DataFinalizado": 2022-01-01T11:50:51,
    "Result": {
     "Cilindradas": 1984,
     "Categoria": "PARTICULAR",
     "Cor": "CINZA",
     "Motor": "CXD057886",
     "Capacidade Máxima de Carga": 0.0,
     "Peso Bruto Total": 1.95,
     "Capacidade Máxima de Tração": 1.95,
     "Eixos": 2,
     "Local": "SAO PAULO",
     "Data de Emissão": "11/01/2022",
     "Observações": ""
    }
  }
}

Status Code 400

Não encontrado.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	1
Mensagens	Descrição dos erros	String[]	"Mensagens": "Mensagens": []

Status Code 401

Usuário/Senha inválidos.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	1
Mensagens	Descrição dos erros	String[]	"Mensagens": "Mensagens": []

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK/ERRO	ERRO
Mensagens	Descrição dos erros	String[]	"Mensagens": []

Exemplo

{
  "Status": 0,
  "Mensagens": [
    "string"
  ]
}