Introduction to EWS

The following document provides an overview of the epoints Web Service (EWS), and also a guide on the correct usage.

The EWS Application Programmers Interface (API) is exposed as a REST-like Web Service, with three key resources of User, Transactions and Tags. When correctly manipulated these three resources will allow you to easily reward Users with epoints, and track exactly what you are spending and also how you are distributing points.

Legals

Agreement

Before integrating EWS into your site we need to agree on the actions you will be rewarding with epoints, for example:

  1. Registration
  2. Commenting
  3. Completing profile
  4. Frequent/ repeat visits
  5. Entering competitions
  6. Others...

Please send us an email to tony@iatltd.com to agree on the above.

Pre-launch Approval

Before launching the EWS live on your site we need to review the API calls to make sure everything works correctly. For that reason, we would like to ask you to let us know once you have finished the integration process and you are ready to go live with EWS. Please send us an email to tony@iatltd.com when you are ready and we will review the API calls from our side and get back to you in 48 hours.

Authorization and Authentication

General

For authentication and authorisation purposes an Access Key and Short Name are provided that provide access to all functionality described within this document.

Please contact the epoint customer services team if you require an Access Key and Short Name.

Connection/Transport Security

Before you begin the integration process please make sure to send us the following:

  1. IP address that will be working on the integration.
  2. Agreement on what actions will be rewarded.

HMAC

  1. TBD

  2. Not on QA