DEA recognition in a nutshell

We recently released this “easyapi” in order to keep things simple. That means: one api for the purpose of checking for disposable email domains, regardless of the needed format. The details:

API Key

In order to access this service you need a api key. You can generate and find find your personal api key at the management website. Please sign-up first.

Available Output Formats

URL Syntax and example

Syntax: http://check.block-disposable-email.com/easyapi/{outputformat}/{apikey}/{domain2check}

Example for:

  • json output
  • used api-key: 12345abc (please get your own)
  • domain to test: block.bdea.cc
http://check.block-disposable-email.com/easyapi/json/12345abc/block.bdea.cc

BTW: You may always use the domains “block.bdea.cc” and “ok.bdea.cc” for testing purposes. They will not deduct credits of your account.

How to send a query and get a response

JSON

Please note that the number of response parameters may change from time to time to tell you more about particular domains. So please check back occasionally.

    1. request_status: Describes if the server succeeded or found any problems (always in lower case).
      • success: Everything fine, the request has been handled as expected and the checks will be performed.
      • fail_key: Something is wrong with your api key. Please double-check, request a new one or contact me.
      • fail_server: The server could not connect to the database or had some other problems.
      • fail_input_domain: The domain you requested was sent in a wrong format, wg. without a dot, or with a dot at the end of the string, any other mismatch, or simply a non existing domain.
      • fail_parameter_count: You missed to submit an apikey, the desired output format or the domain name was empty.
      • fail_key_low_credits: You used up your credits. The current and any additional request will be answered with ok (domain_status = ok) without really checking the domain. Consider to buy additional credits. The status api tells you more about the status of your api key and related issues.
    2. domain_status: The simple answer if you should block or accept a domain (always in lower case).
      • ok: Everything is fine with the domain, we did not find any dea activities for the given domain at the moment of your request. Accept your new subscriber.
      • block: Uh, the requested domain has been flagged as handpicked dea domain. Which means you should consider blocking this subscriber.
    3. version: Tells you the current version of this api service.
    4. servertime: The local time of the server in the moment of your request. If you feel any troubles and want to contact us please tell us this time so we are able to find the corresponding log.
    5. execution_time: Time in seconds needed to process the request on server side (excluding time needed between client and server).
    6. server_id: The internal name of the responding server.

Example JSON request and output

Request:

http://check.block-disposable-email.com/easyapi/json/12345abc/block.bdea.cc

Response:

{“request_status”:”success”,”domain_status”:”block”,”version”:”0.2″,”servertime”:”2015-10-26 21:50:17″,”execution_time”:0.146892786026,”server_id”:”mirror6_amsterdam”}

PHP serialized

Simply change the output format parameter to “serial”. The available output values are exactly the same as described for JSON – but in PHP serialized format. It looks like this:

Request:

http://check.block-disposable-email.com/easyapi/serial/12345abc/block.bdea.cc

Response:

a:5:{s:14:"request_status";s:7:"success";s:13:"domain_status";s:5:"block";s:7:"version";s:3:"0.1";s:10:"servertime";s:19:"2013-01-14 22:41:16";s:9:"server_id";s:15:"mirror2_chicago";}
Simple Text output

While we recommend using the JSON or PHP serialized format there are situations where users are requesting such easy responses. To get the text output use “txt” as output format parameter.

Request:

http://check.block-disposable-email.com/easyapi/txt/12345abc/block.bdea.cc

Response:

block

The output is really simple, these are possible responses (always in lower case) when using this output type:

  • ok: everything fine with the domain
  • block: the requested domain is used by disposable email address services, better block it
  • fail_key: Something is wrong with your api key. Please double-check, request a new one or contact us.
  • fail_server: The server could not connect to the database or had some other problems.
  • fail_input_domain: The domain you requested was sent in a wrong format, wg. without a dot, or with a dot at the end of the string, any other mismatch, or simply a non existing domain.
  • fail_parameter_count: You missed to submit an apikey, the desired output format or the domain name was empty.
  • fail_key_low_credits: You used up your credits. The current and any additional request will be answered with ok (domain_status = ok) without really checking the domain. Consider to buy additional credits. The status api tells you more about the status of your api key and related issues.

Scriptexample

See here for a script example. Special thanks to Category5 Technology TV for providing the code.

Support

You need additional information that we haven’t already listed in our FAQ‘s?

You have a great idea for new features?

Please raise a helpdesk ticket and we’ll answer as soon as possible?

Version Tracker for easyapi

  • v 0.2 (2015-10-09): Added response attribute “execution_time”.
  • v 0.1 (2013-01-14): New easyapi released. See this post for additional information.