Can we help you?
The understanding of how a product works and of its scope is the key to realize its possibilities and what it can do for you. This is what these FAQs are meant for.
When you forward an email to eEvidence as part of, say, an ERP workflow, you are confident we will deliver it to destination within seconds. However, how do you know we really did? The JSON and RESTful web services for data interchange through HTTPS, allow you to retrieve the status of your registered emails by directly querying our databases. Simple as that.
Some key resources needed to be deployed so as to provide this feature in a reliable manner. For this reason, this feature is available for Extended plans only.
About our JSON web service solution
JSON, or JavaScript Object Notation, is an open standard format that uses human-readable text to transmit data objects consisting of key:value pairs. It is used primarily to transmit data between a server and web application, as an alternative to XML.
The eEvidence JSON query is implemented by defining four aspects:
| /srv/jlist | Base URI for the JSON web service |
| /{private.key} | Customer query private key |
| /{start.date} | Starting date for the records to be retrieved in YYYYMMDD format |
| /{end.date} | Ending date for the records to be retrieved in YYYYMMDD format |
Once implemented, the query returns the relevant data for non-delivered eEvids within the date range following the following schema:
| Key | Value |
| id: | eEvid ID |
| type: | 'OUT' = request for registering outgoing email, 'IN' = request for registering incoming email, 'FILE' = request for registering body and attachments only |
| xfield: | email ID at source (X-eEvid-SourceID shown in the email header) |
| date: | delivery date in YYYY-MM-DD hh:mm:ss format |
| subject: | email subject |
| to: | email recipient |
| af: | attachment filenames |
| rcode: | reply code at destination |
| rlog: | full reply message at destination |
| Status: | 'S' = Confirmed, 'D' = Confirmed with annotation, 'P' = Pending delivery, 'E' = Failed, 'H' = Half-done |
| tx_id: | secondary ID for retrieving the eEvid.Cert through scripting |
The most elementary query is limited to the four basic parameters and does not return records for confirmed eEvids: in 99.9% of the cases, emails are delivered within seconds, so why waste time and resources. Optional parameters allow you to retrieve all records —{full}—, regardless of their status, or check the status of a particular email —{xfield}.
Download the instructions for implementing the JSON web service. For any further questions, please contact Support.
About our RESTful web service solution
A RESTful web service (also called a RESTful web API) is a web service using the principles of REST's architectural style.
The eEvidence RESTful query is implemented by defining four aspects:
| /srv/ilist | Base URI for the JSON web service |
| /{private.key} | Customer query private key |
| /{start.date} | Starting date for the records to be retrieved in YYYYMMDD format |
| /{end.date} | Ending date for the records to be retrieved in YYYYMMDD format |
Once implemented, the query returns the relevant data for non-delivered eEvids within the date range, in regular CSV format.
Thank you for asking!
eEvidence Support Team
© 2023 EEVIDENCE