Introduction

EYEmails services are available through our web API. EYEmails API allows to add list for your client emails, send email campaigns lists and send sms, as well as getting statistics about your sent campaigns (clicks and views).

Authentication

To authenticate with Eye Mails API ,the process is easy. With any request you must send 2 parameters that are required. First is your email (the email you use to sign in), to know your account that are currently using, and the second is a valid API key that you can generate (usually 22 characters).

Pass these credentials in every process as shown below:

‘application/x-www-form-urlencoded’ POST/GET https://eyemails.com/api/developer/ api_key:’YOURAPIKEY’ and email:’YOUREMAIL’
API Methods

The Mailer API that lets you use EyeMails to send your transactional emails like welcome letters, password resets, and account activations. To send a transactional email, just POST to https://eyemails.com/api/developer/ with the data based on each method

Send Emails to lists using schedule

POST to https://eyemails.com/api/developer/send_emails [POST]

Sends Emails to a list using scheduleId. Returns success message if successful.

POST to https://eyemails.com/api/developer/send_emails_to_list [POST]

Sends Emails to a list using scheduleId and Names of lists. Returns success message if successful.

POST to https://eyemails.com/api/developer/save_campaign [POST]

Create Campaign and save it. Returns scheduleId if successful.

The List API lets you use EyeMails to create lists and send your transactional emails to lists. To send a transactional email, just POST to https://eyemails.com/api/developer/ with the data based on each method

POST to https://eyemails.com/api/developer/create_list [POST]

Create List and save it. Returns success message if successful.

POST to https://eyemails.com/api/developer/import_emails_to_list [POST]

Import Emails to a List. Returns success message if imported successfully.

The Statistics API lets you use EyeMails to read statistics clicks and views of your campaign. To send a transactional email, just pass to https://eyemails.com/api/developer/ the parameters based on each method

pass parameters to https://eyemails.com/api/developer/clicks [GET]

Get the number of clicks by each email for your campaign. Returns emails and and number of clicks.

pass parameters to https://eyemails.com/api/developer/views [GET]

Get the number of views by each email for your campaign.Returns emails and and nb of views.

The SMS API that lets you use EyeMails to send your sms for your clients. To send sms, just POST to  https://eyemails.com/api/developer/  with the data based on each method

Single SMS:

Send Single SMS

POST to https://eyemails.com/api/developer/send_single_sms [POST]

Send SMS to clients. Returns success message if successful.

Bulk SMS:

Create SMS List

POST to https://eyemails.com/api/developer/create_sms_List [POST]

Create List and save it. Returns success message if successful.

POST to https://eyemails.com/api/developer/import_numbers_to_list [POST]

Import Numbers to a List. Returns success message if imported successfully.

POST to https://eyemails.com/api/developer/save_sms_campaign [POST]

Create campaign and save it with schedule. Returns CampaignId and ScheduleId if successful.

POST to https://eyemails.com/api/developer/send_sms [POST]

Send SMS to clients. Returns success message if successful.

{
“Type”: “error”,
“Title”: “api method”,
“ErrorMessage”: “Description of Error”
}