eEvidence API Reference documentation (2.1.2)
This is the eEvidence API documentation. You can find out more about eEvidence at https://eevidence.com.
There API calls are grouped by purpose: the section eEvid is aimed to retrieve e-mail certification status information.
The eEvid typical scenarios include searching for failed emails using the jlist method within a date range, searching for the status of a given email using either its x-field value or the associated eEvid certificate ID - you may use the search function using the x-field value to retrieve the corresponding internal transaction ID. Finally, you can also download the corresponding certificate using the associated internal transaction ID.
Each user has a private_key available to his web console. Moreover, the licence administrator has an additional key: the geteevid_key.
eEvid API methods will only return records associated to the private_key included in the query. However, when querying for a specific email (search or download), the private_key can either be the user's who supposedly sent that email, or the license's user administrator's.
This field is meant to allow a quick match between our records and the customer's system records. To do so, either you include the header label X-eEvid-SourceID in all your emails, or you set your own custom label for the x-field header.
The x-field is a non-standard email header used to identify a given message both in your email systems and in our email systems, so that each email message can be traced back easily in both systems. So whatever label you choose to use, the contents of that field must identify uniquely a single email.
You may retrieve a single email delivery status information by querying the xfield field already mentioned using the ID value your system generated for that given email. You may also query the status using the eevid_id field, which uniquely identifies an eEvid certificate, though it can't be traced back in your email systems. To be able to download an email certificate, you may retrieve the tx_id from the result returned by a search API call - web form certificates have the same tx_id as their corresponding registered emails, so the parameter form must be appended to the download API method.
Please note that most of the time the API methods will return data in JSON format. Each method lists the response types it will return - click on the response to get full information about its contents description. Also note that the all download API methods (eevid email download and eevid form download) will retrieve a PDF file when succesful.
Find failed eevids by date range
Returns a list of failed eevids within the date range.
Query limitations
For now, the JSON web service can be queried without any limitation on the number of queries per time period. There's either no limit on the date range defined on the query: whatever this is, only a maximum of 10,000 records will be returned, from newest to oldest.
path Parameters
| private_key required | string Sender private key |
| geteevid_key required | string Sender geteevid key |
| start_date required | string Start date in format YYYYMMDD |
| end_date required | string End date in format YYYYMMDD |
Responses
successful operation
Search fields are not valid
Invalid credentials
Request samples
- Csharp
- Java
- Javascript
- Python
- Php
- Node
- Go
var client = new RestClient("https://secure.eevid.com/srv2/jlist/private_key/geteevid_key/start_date/end_date"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request);
Response samples
- 200
[- {
- "id": "1RKLZ7J1106N3",
- "type": "IN",
- "xfield": "15725f2bacb312b106ab52cfee2e6107f440dbcaf8a56f99b0cffbe854e13177",
- "date": "2019-07-04T11:21:39.000Z",
- "subject": "API documentation",
- "to": "info@eevidence.com",
- "af": [
- { }
], - "rcode": 250,
- "rlog": "250 OK J64DLc475f050838298A_6.0",
- "mt": "2019-07-04 10:42:52+0200",
- "status": "S",
- "tx_id": "bb2a959561d24b5c941c3046caf8f929"
}
]Find eevid by x-field header contents
Return information of the eevid which customer emails' unique ID matches the x-field header contents.
path Parameters
| private_key required | string Sender private key |
| geteevid_key required | string Sender geteevid key |
| search_field required | string Enum: "xfield" "eevid" The search field must be either xfield or eevid. |
| value required | string In case the search field is set to xfield the value expected here is the X-eEvid-SourceID header field contents. If you have setup another label for the x-field email header instead of X-eEvid-SourceID, note that the value expected here is that field contents, not its label. In case the search field is set to eevid the value expecter here is the eEvidence certificate ID. Examples:
|
Responses
successful operation
Invalid credentials
Record not found
Request samples
- Csharp
- Java
- Javascript
- Python
- Php
- Node
- Go
var client = new RestClient("https://secure.eevid.com/srv2/search/private_key/geteevid_key/search_field/value"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request);
Response samples
- 200
{- "id": "1RKLZ7J1106N3",
- "type": "IN",
- "xfield": "15725f2bacb312b106ab52cfee2e6107f440dbcaf8a56f99b0cffbe854e13177",
- "date": "2019-07-04T11:21:39.000Z",
- "subject": "API documentation",
- "to": "info@eevidence.com",
- "af": [
- { }
], - "rcode": 250,
- "rlog": "250 OK J64DLc475f050838298A_6.0",
- "mt": "2019-07-04 10:42:52+0200",
- "status": "S",
- "tx_id": "bb2a959561d24b5c941c3046caf8f929"
}Download an eEvid email certificate
Retrieve an eEvid certificate file (PDF) using the eEvidence tx_id associated to the corresponding registered email. The tx_id key is only available through the search API method for retrieving the status of eEvid processes: in other words, to download a receipt through the geteevid API method, run the search query first to retrieve its tx_id.
path Parameters
| private_key required | string Sender private key. |
| geteevid_key required | string Sender geteevid key. |
| value required | string Contents of the tx_id field. |
Responses
PDF file
Invalid credentials
Record not found
Request samples
- Csharp
- Java
- Javascript
- Python
- Php
- Node
- Go
var client = new RestClient("https://secure.eevid.com/srv2/geteevid/private_key/geteevid_key/value"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request);
Download an eEvid form certificate
Retrieve an eEvid web form certificate file (PDF) with the answers provided by the recipient of the original registered email. The tx_id key to be used is that of the associated registered email - as above, use the search API method.
path Parameters
| private_key required | string Sender private key. |
| geteevid_key required | string Sender geteevid key. |
| value required | string Contents of the tx_id field. |
Responses
PDF file
Invalid credentials
Record not found
Request samples
- Csharp
- Java
- Javascript
- Python
- Php
- Node
- Go
var client = new RestClient("https://secure.eevid.com/srv2/geteevid/private_key/geteevid_key/value/form"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request);
Replaces the x-field message ID header label with a new label
The default x-field message ID header label is X-eEvid-SourceID. This method sets the x-field header label to the given input for all the group members the user belongs to.
path Parameters
| private_key required | string Sender private key |
| geteevid_key required | string Sender geteevid key |
| value required | string New label for the x-field header, which will replace the X-eEvid-SourceID header |
Responses
Successful operation
Invalid credentials
Request samples
- Csharp
- Java
- Javascript
- Python
- Php
- Node
- Go
var client = new RestClient("https://secure.eevid.com/srv2/xfield/private_key/geteevid_key/value"); var request = new RestRequest(Method.PUT); IRestResponse response = client.Execute(request);