WS205 - Event export

This integration aims to allow the export of document events in the system.

Authentication

• Calls will have transport-level authentication (Basic Authentication);
• Request user / password from the account administrator.

Features

• URL

  https://events-api.comprovei.com/events

• Method:

  GET

• URL parameter:

  • qty: Quantity
    
    • Example: https://events-api.comprovei.com/events?qtd=100

  ---

  • eventId: Event ID
    
    • Example: https://events-api.comprovei.com/events?eventId=b08a68121fa427dbb5e7876d5c4d797df70f744a53ea22e3698c5175ee323296

  ---

  • qty & eventId: Quantity & event Id
    
    • Example: https://events-api.comprovei.com/events?qtd=10&eventId=b08a68121fa427dbb5e7876d5c4d797df70f744a53ea22e3698c5175ee323296

  ---

• Success:

  • Code: 200
    Content:

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

• Error:

  • Code: 403
    Content:

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