This documentation is no longer supportedFor the latest information on our API, see Getting Started with the RedEye API
The RedEye Application Programming Interface (API) provides you with access to resources and endpoints that allow you to perform various operations such as sending emails, SMS texts, and updating customer preferences.
In this section you can find out how to access the RedEye REST API, how to authenticate requests, encode HTML characters and ensure security.
How to Access the API
You can access the API by using a single URL entry point as follows:
https://api.redeye.com/client_ID/service_ID/<method>Example URL:
https://api.redeye.com/123456/email/sendAuthentication
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.
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:
- User name 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.
General
- 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 and recommend the encoding of HTML character entities that are passed as string values in the main body of a JSON request. When you interact with the RedEye API, we recommend this as a best practice to prevent rendering issues and error responses. This applies to special characters such as; currency symbols, brackets, braces, separators, arrow characters and maths signs and symbols to name a few.
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 support ISO-8859-1 characters in the subject line, body, merge fields and URL links for emails and SMS messages. We do not currently support internationalised email addresses - these will not be stored on the database or allowed in mailings.
Formatting
The body sample json string payloads displayed for each API service are in the format that Redeye support. Please note that array values are not currently supported, except in the case of the "recipients" or "person" parameter where you can have multiple recipients/persons listed in the payload. When using one or more recipients, it is advised to put any parameters inside square brackets.