WS205 - Exportação de eventos

Esta integração tem por objetivo permitir fazer a exportação de eventos de documentos no sistema.

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://events-api.comprovei.com/events

• Método:

  GET

• Parâmetro URL:

  • qtd: Quantidade
    
    • Exemplo: https://events-api.comprovei.com/events?qtd=100

  ---

  • eventId: ID do evento
    
    • Exemplo: https://events-api.comprovei.com/events?eventId=b08a68121fa427dbb5e7876d5c4d797df70f744a53ea22e3698c5175ee323296

  ---

  • qtd & eventId: Quantidade & Id do evento
    
    • Exemplo: https://events-api.comprovei.com/events?qtd=10&eventId=b08a68121fa427dbb5e7876d5c4d797df70f744a53ea22e3698c5175ee323296

  ---

• Sucesso:

  • Código: 200
    Conteúdo:

      {
          "NumeroRegistrosExportados": "999",
          "NumeroDeRegistrosAExportar": "999",
          "Eventos": [...]
      }
    

• Erro:

  • Código: 403
    Conteúdo:

      {
          "mensagem": "Método não autorizado para esse usuário. Entrar em contato com a Comprovei.",
          "code": 403
      }