This is our new version of API. We invite you to start using it and give us your feedback
E-goi can be integrated with many environments and programming languages via our REST API.We've created a developer focused portal to give your organization a clear and quick overview of how to integrate with E-goi.The developer portal focuses on scenarios for integration and flow of events. We recommend familiarizing yourself with all of the content in the developer portal, before start using our rest API.
The E-goi Registered is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
Request data is passed to the API by POSTing JSON objects to the API endpoints with the appropriate parameters.
BaseURL = registered.egoiapp.comThis API supports 5 HTTP methods:
- GET:The HTTP GET method is used to read (or retrieve) a representation of a resource.
- POST:The POST verb is most-often utilized to create new resources.
- PATCH:PATCH is used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource
- PUT:PUT is most-often utilized for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource.
- DELETE:DELETE is pretty easy to understand. It is used to delete a resource identified by a URI.
We use a custom authentication method, you will need a apikey that you can find in your account settings. Below you will see a curl example to get your account information: #!/bin/bash curl -X GET 'https://registered.egoiapp.com/ping'
-H 'accept: application/json'
-H 'Apikey:
Stream limits are security mesures we have to make sure our API have a fair use policy, for this reason, any request that creates or modifies data (POST, PATCH and PUT) is limited to a maximum of 20MB of content length. If you arrive to this limit in one of your request, you'll receive a HTTP code 413 (Request Entity Too Large) and the request will be ignored. To avoid this error in importation's requests, it's advised the request's division in batches that have each one less than 20MB.
Timeouts set a maximum waiting time on a request's response. Our API, sets a default timeout for each request and when breached, you'll receive an HTTP 408 (Request Timeout) error code. You should take into consideration that response times can vary widely based on the complexity of the request, amount of data being analyzed, and the load on the system and workspace at the time of the query. When dealing with such errors, you should first attempt to reduce the complexity and amount of data under analysis, and only then, if problems are still occurring ask for support.
For all these reasons, the default timeout for each request is 10 Seconds and any request that creates or modifies data (POST, PATCH and PUT) will have a timeout of 60 Seconds. Specific timeouts may exist for specific requests, these can be found in the request's documentation.
Apikey
Security Scheme Type: API Key
Header parameter name: Apikey
Pings the API
Checks if API is up and running
Responses
Egoi Public API Server
https://registered.egoiapp.com/ping
Response samples
- 200
- 500
- 503
Content type
application/json
"result": "pong"{
}
Get all registered messages
Get all registered messages
Authorizations:
Apikey
query Parameters
| offset | integer >= 0 Default: 0 Element offset (starting at zero for the first element) |
| limit | integer [ 1 .. 100 ] Default: 10 Number of items to return |
| subject | string registered message subject |
| to | string registered message to |
| start_date | string <date> (date) Example: start_date=YYYY-MM-DD start date |
| end_date | string <date> (date) Example: end_date=YYYY-MM-DD end date |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered
Response samples
- 200
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"total_items": 1, "items": [ { "message_id": "string", "id": "string", "channel": "email", "subject": "Subject", "to": "example@example.com", "date": "YYYY-MM-DD hh:mm:ss", "pdf_certificate_link": "https://example.com/certificate.pdf", "pdf_link": "https://example.com/registered.pdf" } ]{
}
Get Registered
Return registered information given its ID
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}
Response samples
- 200
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"message_id": "string", "id": "string", "channel": "email", "subject": "Subject", "to": "example@example.com", "date": "YYYY-MM-DD hh:mm:ss", "pdf_certificate_link": "https://example.com/certificate.pdf", "pdf_link": "https://example.com/registered.pdf"{
}
Get all registered events
Get all registered events
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}/event
Response samples
- 200
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"total_items": 1, "items": [ { "id": "string", "channel": "email", "type": "DELIVERY", "sender": "example@example.com", "destination": "example@example.com", "date": "YYYY-MM-DD hh:mm:ss" } ]{
}
Creates a registered custom event
Creates a registered custom event
Authorizations:
Apikey
Request Body schema: application/json
| channel | string Enum: "Email" "Sms" Tipo de canal (Email ou Sms) |
Array of objects |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/custom/event
Request samples
- Payload
Content type
application/json
"channel": "Email", "events": [ { "eventDate": 1620259200, "registerId": "HASH", "customData": "Custom Event" } ]{
}
Response samples
- 200
- 400
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"result": "success"{
}
Get all registered evidences
Get all registered evidences
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
query Parameters
| offset | integer >= 0 Default: 0 Element offset (starting at zero for the first element) |
| limit | integer [ 1 .. 100 ] Default: 10 Number of items to return |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}/evidence
Response samples
- 200
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"total_items": 1, "items": [ { "id": "00000000000000000", "channel": "email", "name": "example_registered.pdf", "size": "100", "created_at": "YYYY-MM-DD hh:mm:ss", "updated_at": "YYYY-MM-DD hh:mm:ss" } ]{
}
Creates a registered evidence
Creates a registered evidence
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}/evidence
Response samples
- 200
- 400
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"result": "success"{
}
Remove registered evidence
Remove registered evidence given its ID and registeredID
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
| evidence_id required | string (Evidence ID) Evidence ID |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}/evidence/{evidence_id}
Response samples
- 401
- 403
- 404
- 408
- 409
- 429
- 500
- 503
Content type
application/json
"title": "Unauthorized", "status": 401, "detail": "The request has not been applied because it lacks valid authentication credentials for the target resource"{
}
Download Registered Evidence
Return registered evidence pdf given its ID and version
Authorizations:
Apikey
path Parameters
| registered_id required | string (Registered ID) Registered ID |
| evidence_id required | string (Evidence ID) Evidence ID |
Responses
Egoi Public API Server
https://registered.egoiapp.com/registered/{registered_id}/evidence/download/{evidence_id}
Response samples
- 401
- 403
- 408
- 422
- 429
- 500
- 503
Content type
application/json
"title": "Unauthorized", "status": 401, "detail": "The request has not been applied because it lacks valid authentication credentials for the target resource"{
}
