The RedEye API uses the HTTP Basic access method of authentication for server-to-server requests.

Before you start, make sure that you've received your login credentials from your RedEye account manager as these must be used in the HTTP header of each API request. Each API request must contain a JSON header to denote that the incoming data is in JSON format.

🚧
Warning: API requests are rejected if they do not contain a JSON header.

Data Validation

During a request transmission, the following data is validated in the HTTP header:

Username and Password combination
Client ID

Security

We support the following versions of Transport Layer Security (TLS) to ensure secure communication and data integrity:

TLS 1.1
TLS 1.2

IP Filtering

API service requests can be secured with IP based filtering. You can request IP filtering to be set up so that each of your API requests will only be accepted from a specific IP address or an IP range.

📘
To set up IP filtering, speak to your RedEye account manager.

Formatting

Email addresses not in the format of someone@domain will result in an error.
Email addresses that do not exist will appear as "PROCESSED" even if the recipient does not receive the email.
Email addresses will be converted to lower case before insertion into the database. The APIs are case-sensitive so it will not find [email protected] if the person's email address is stored as [email protected].

Encoding

We support ISO-8859-1 characters in the subject line, body, merge fields and URL links for emails and SMS messages.

We recommend encoding characters not in the ISO-8859-1 range that are passed as string values in the main body of a JSON request.

If you include characters in the string that match the characters used to form the JSON structure such as curly braces { }, square brackets [ ] or quotation marks " ", then you must encode these characters to prevent your code from breaking.

📘
See: http://www.whatsmyip.org/html-characters/ for a full list of special characters to encode.

🚧
We do not currently support internationalised email addresses - these will not be stored on the database or allowed in mailings.

System Test

Test your connection by running a System Test.

URL to use:

METHOD: GET
https://api.redeye.com/[client_id]/systemtest/helloworld

Response sample:

{
 "successMessage": "Hello World"
}