Emma’s platform is accessible through our public API. The API provides access to the following areas:
All API calls must include an HTTP Basic authentication header containing the public & private API keys for your account. These keys can be managed from within the Emma application. Additionally, the path for each call should be prefixed with your Emma account ID. This allows for cases where a single user has access to multiple accounts.
The host to access the API is: https://api.e2ma.net. All calls must be made over HTTPS. For example if your account ID is 123, you could list the members in your account by calling:
Request and response data is transferred as JSON. Responses with a large number of results should be paginated; the query parameters start and end can be used to specify how large a set of items to retrieve in each call, with a maximum page size of 500. Additionally, for any call you can retrieve a count of the results (instead of the results themselves) by appending a query parameter of count=true.
So, to pull a large number of results, you start with a count:
Then, iterate over the list in blocks of 500:
Requests for page sizes larger than 500 will limited to start + 500.
Calls are rate-limited to prevent accidental overuse. If you exceed the limit you will receive a response of 403 Rate Limit Exceeded until enough time has elapsed between calls.
The API calls are organized by their main entity type in the following sections. Each call includes sample request & response data.