WS323 - Agendamento de documentos

WS323 - Nosso serviço para agendamento de documentos

Esta integração tem por objetivo abrir solicitação para realizar agendamento dos documentos.

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
06/05/2021	12/05/2021	Disponibilização do webservice para homologação
06/05/2021	17/05/2021	Disponibilização do webservice para produção
20/07/2021	20/07/2021	Disponibilização do campo "code" para o serviç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/documents/scheduling>

• Método:

  POST

Esta integração retorna um protocolo para acompanhamento - WS301

Parâmetros

Exemplo

[{
    "key" : "41190943434343434343550020003567351594519865",
    "date" : "2021-05-06",
    "annotation" : "Cliente solicitou a entrega nesta data",
    "code" : "997"
}]

Propriedade	Tipo	Descrição
key	Alfanumérico	Chave de acesso do documento que será agendado (obrigatório)
date	Alfanumérico	Data em que o documento está agendado no formato "AAAA-MM-DD" (obrigatório)*
annotation	Alfanumérico	Observação a respeito do agendamento (opcional)
code	Alfanumérico	Código do evento(opcional*): * 997 - Agendamento * 993 - "Programado" ou "Tentativa de agendamento" (De acordo com configuração da conta)

*

• Caso não seja enviado o campo "code", o sistema entenderá que houve um agendamento.
  Pode ser enviado no formato "AAAA-MM-DD HH:MM:ss".

• Sucesso:

  • Código: 202
    Conteúdo:

    {
        "message" : "OK",
        "protocol" : "<protocol>"
    }
    

    {
        "message" : "Algumas notas enviadas apresentaram erros. Consulte o protocolo para detalhes",
        "protocol" : "<protocol>" 
    
    }
    

• Erro:

  • Código: 400
    Conteúdo:

    {
        "message": "Corpo da requisição deve ser um array"
    }
    

    {
        "message" : "Corpo da requisição não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, elemento deve ser um objeto json válido" 
    }
    

    {
        "message" : "Na posição p, elemento não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'key' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'key' não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'annotation' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'annotation' não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'date' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'date' não pode estar vazio" 
    }