Address Book Reader
The Address Book Reader returns the names and email addresses of the contacts in a webmail address book.
URL
https://api.rapleaf.com/v2/abook
Request
Example Request
POST /v2/abook HTTP/1.1
Host: api.rapleaf.com
Authorization: 0123456789abcdef
Content-Type: application/x-www-form-urlencoded

login=dummy@gmail.com&password=12345
To send this request from your browser for testing purposes see the "Help" section at the bottom of this page.
Parameter Descriptions
Parameter Required? Description
Authorization Header Required The Authorization header is where you put your API key. The API key is the unique key assigned to you by Rapleaf. You can find your API Key here.
For testing (or if circumstances require it) you can send the API key in the query string using 'api_key='
login Required Email address used to login to webmail service.
password Required Password for webmail service.
service Optional The webmail service to use. Supported values are 'gmail', 'yahoo', 'hotmail', and 'aol'.

We will attempt to determine the service from the login email address provided. You do not need to provide the service parameter when the email address uses any of the following domains: gmail.com, yahoo.com, hotmail.com, aol.com, googlemail.com, msn.com, sbcglobal.net.

These four services may support additional email domains that we don't recognize. For example, joe@joes-domain.com might be serviced by Gmail. You must provide a service parameter for such domains.
callback_url Optional The person API provides information about a person. Rapleaf searches for this information on the public internet, and this process may take minutes or hours for email addresses that are new to the Rapleaf system. If you specify a callback url, it will be called after Rapleaf has prepared information for most of the contacts in the address book. You can then retrieve this information with the person API.
Response
HTTP Status Codes
Status Code Description
200 OK Request processed successfully.
400 Bad Request The request did not contain all required parameters. Look at the response body to see which parameter was missing.
401 Unauthorized API key was not provided or is invalid.
420 Sign In Error The login or password were incorrect.
500 Internal Server Error There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com.
520 Address Book Error There was an error while reading the contacts from the address book.
Note: This list does not cover all possible HTTP Status Codes that could be returned, only those returned specifically from our API. For example, if the request cannot make it to our API you will likely get a "503 Service Unavailable" response. With this in mind do not code exclusively to handle the response codes listed above.
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<contacts>
  <contact name="Dummy1" email="dummy1@rapleaf.com" />
  <contact name="Dummy2" email="dummy2@rapleaf.com" />
  <contact name="Dummy3" email="dummy3@rapleaf.com" />
  <contact name="Dummy4" email="dummy4@rapleaf.com" />
  <contact name="Dummy5" email="dummy5@rapleaf.com" />
</contacts>

Client Libraries
Client libraries: These libraries make it even easier for you to integrate the Address Book functionality into your PHP, Perl, and Python applications. Rapleaf is providing these links as a convenience and cannot take any responsibility for the libraries.
Help
For testing we recommend using a helpful Firefox Add-on called Modify Headers which lets you set the HTTP headers of your web requests. By setting the Authorization header to your API Key you can experiment with API requests within your browser. Also, the POST parameters can be supplied in the url allowing you to use a GET request.

Please email questions to Rapleaf Developer Support.