WS301 - Consulta de Protocolo

Nosso serviço para acompanhamento da requisição

Esta integração tem por objetivo Consultar o andamento de uma requisição.

Autenticação

• As chamadas terão autenticação a nível de transporte (Basic Authentication);
• Solicite o user / password ao administrador da conta.

Características

• URL

  <https://entregas-api.comprovei.com/v1/protocols/<protocol>>

• Método:

  GET

• Sucesso:

  • Código: 200
    Conteúdo:

Nome	Tipo	Descrição
protocol	Alfanumérico	Protocolo gerado
requested_at	Data e hora	Hora que a requisição foi feita
method	Alfanumérico	Método chamado
processed	Numérico	0 – Processamento ainda não iniciado 1 – Processado 2 – Em processamento
success	Numérico	0 – Falha 1 – Sucesso Em branco - Pendente
requested_data	JSONObject	Dados enviados na requisição
response_data	JSONObject	Resposta da requisição

• Erro:

  • Código: 404
    Conteúdo:

        {
            "message" : "Protocolo não encontrado"
        }
    

  • Código: 400
    Conteúdo:

        {
            "message" : "Protocolo inválido"
        }