Usage

Quick overview

You can use HTTP API direct in you system. HTTP API protocol specification described on http://docs.emailvoid.apiary.io/

EmailVoid also provide reuse module and library on some language.

Usage example

You may search more example and create support issue on repositories https://github.com/emailvoid

Example

Let's I show you sample request and response on unix console:

Step 1. Process authorize

# curl -v -X POST http://www.emailvoid.com/api/3.0/domain/emailvoid.com/msgs/count

Warning: Without api_key service always return 403 error code

* Hostname was NOT found in DNS cache
*   Trying 104.236.28.148...
* Connected to www.emailvoid.com (104.236.28.148) port 80 (#0)
> POST /api/3.0/domain/emailvoid.com/msgs/count HTTP/1.1
> User-Agent: curl/7.38.0
> Host: www.emailvoid.com
> Accept: */*
>
< HTTP/1.1 403 Forbidden
* Server nginx/1.10.3 is not blacklisted
< Server: nginx/1.10.3
< Date: Fri, 03 Nov 2017 01:14:53 GMT
< Content-Type: application/json
< Content-Length: 97
< Connection: keep-alive
<
* Connection #0 to host www.emailvoid.com left intact
{"code": 1, "description": "You should verefy your API KEY", "error": "Wrong or outdate API KEY"}

Step 2. Get messages count on our domain

$ curl -v -X POST --header "X-Auth: b8818f4c8594021a9ca1489d135a2540d726f855767496788c6f1d76f2f5917d" http://www.emailvoid.com/api/3.0/domain/emailvoid.com/msgs/count

We specify api_key in header X-Auth and expect domain message count.

* Hostname was NOT found in DNS cache
*   Trying 104.236.28.148...
* Connected to www.emailvoid.com (104.236.28.148) port 80 (#0)
> POST /api/3.0/domain/emailvoid.com/msgs/count HTTP/1.1
> User-Agent: curl/7.38.0
> Host: www.emailvoid.com
> Accept: */*
> X-Auth: b8818f4c8594021a9ca1489d135a2540d726f855767496788c6f1d76f2f5917d
>
< HTTP/1.1 200 OK
* Server nginx/1.10.3 is not blacklisted
< Server: nginx/1.10.3
< Date: Fri, 03 Nov 2017 01:18:54 GMT
< Content-Type: application/json
< Content-Length: 23
< Connection: keep-alive
<
* Connection #0 to host www.emailvoid.com left intact
{"count": 1, "code": 0}

That is very simple.