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 http://www.emailvoid.com/api/2.0/msg/count

Warning: Without api_key service always return error 403 code

* STATE: INIT => CONNECT handle 0x600060600; line 1103 (connection #-5000)
* Added connection 0. The cache now contains 1 members
*   Trying 104.236.27.118...
* STATE: CONNECT => WAITCONNECT handle 0x600060600; line 1156 (connection #0)
* Connected to www.emailvoid.com (104.236.27.118) port 80 (#0)
* STATE: WAITCONNECT => SENDPROTOCONNECT handle 0x600060600; line 1253 (connection #0)
* STATE: SENDPROTOCONNECT => DO handle 0x600060600; line 1271 (connection #0)
> GET /api/1.0/msg HTTP/1.1
> Host: www.emailvoid.com
> User-Agent: curl/7.46.0
> Accept: */*
>
* STATE: DO => DO_DONE handle 0x600060600; line 1350 (connection #0)
* STATE: DO_DONE => WAITPERFORM handle 0x600060600; line 1477 (connection #0)
* STATE: WAITPERFORM => PERFORM handle 0x600060600; line 1487 (connection #0)
* HTTP 1.1 or later with persistent connection, pipelining supported
< HTTP/1.1 403 Forbidden
* Server nginx/1.6.2 is not blacklisted
< Server: nginx/1.6.2
< Date: Fri, 07 Apr 2017 08:29:24 GMT
< Content-Type: application/json
< Content-Length: 97
< Connection: keep-alive
<
* STATE: PERFORM => DONE handle 0x600060600; line 1645 (connection #0)
* Curl_done
* 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 --header "X-Auth: b8818f4c8594021a9ca1489d135a2540d726f855767496788c6f1d76f2f5917d" http://www.emailvoid.com/api/2.0/msg/count

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

* STATE: INIT => CONNECT handle 0x6000607b0; line 1103 (connection #-5000)
* Added connection 0. The cache now contains 1 members
*   Trying 104.236.27.118...
* STATE: CONNECT => WAITCONNECT handle 0x6000607b0; line 1156 (connection #0)
* Connected to www.emailvoid.com (104.236.27.118) port 80 (#0)
* STATE: WAITCONNECT => SENDPROTOCONNECT handle 0x6000607b0; line 1253 (connection #0)
* STATE: SENDPROTOCONNECT => DO handle 0x6000607b0; line 1271 (connection #0)
> GET /api/2.0/msg/count HTTP/1.1
> Host: www.emailvoid.com
> User-Agent: curl/7.46.0
> Accept: */*
> X-Auth: b8818f4c8594021a9ca1489d135a2540d726f855767496788c6f1d76f2f5917d
>
* STATE: DO => DO_DONE handle 0x6000607b0; line 1350 (connection #0)
* STATE: DO_DONE => WAITPERFORM handle 0x6000607b0; line 1477 (connection #0)
* STATE: WAITPERFORM => PERFORM handle 0x6000607b0; line 1487 (connection #0)
* HTTP 1.1 or later with persistent connection, pipelining supported
< HTTP/1.1 200 OK
* Server nginx/1.6.2 is not blacklisted
< Server: nginx/1.6.2
< Date: Fri, 07 Apr 2017 09:17:04 GMT
< Content-Type: application/json
< Content-Length: 23
< Connection: keep-alive
< Set-Cookie: SESSION_ID=63606278a22e4d34a63ad807d909d134; httponly
<
* STATE: PERFORM => DONE handle 0x6000607b0; line 1645 (connection #0)
* Curl_done
* Connection #0 to host www.emailvoid.com left intact
{"count": 4, "code": 0}

That is very simple.