Welcome

APSIS' REST based API

This version is based on a REST style API, which means that API requests are made via URLs over HTTP. This is similar to the way a web page is returned in a web browser when a certain URL is called. One great advantage of a REST based API is that it is very easy to use from almost all programming languages and all platforms.

What can the API be used for?

The new APSIS Pro REST-based API is developed to let you connect your or your customers' system environments with APSIS Pro. Or, you can build add-ons and build a business around adding value to the many thousands of customers of the APSIS Pro platform. Using the REST API you can create, update, delete and read various types of data and perform a number of actions in APSIS Pro. This lets you e.g. sync subscribers and related data between CRM systems, sending newsletters, campaigns or Transactional Emails without being logged in to the APSIS Pro user interface, or get behavioral data from your APSIS Pro send-outs back to your own systems environment.

Queued, paginated and direct API calls

The API consists of three types of API calls to be used for different scenarios:

Queued

Your request is put in a queue and you will poll the queue to retrieve the URL to the response. Queued methods are generally used for when all data should be retrieved, e.g. GetAllSubscribers that returns all subscribers on account. The purpose of using queued API methods is to reduce the load on APSIS Pro and to minimize the risk of a timeout, especially since an API call could potentially return hundreds of thousands of rows of data or more.

Paginated

Paginated API calls are direct but it will return a subset of the data according to your request. Paginated methods are suitable for when you prefer to work with a subset of data rather than all. The concept is to see it similar to turning pages in a book.

Direct

A direct API call is most often used to create, update, get or delete a single data post, like the method GetSubscriberIdByEmail. More direct methods will be added to the API as soon as the API limitations have been implemented according to below.

XML and JSON

This API can be consumed using either XML or JSON, depending on your preferences. Please note that if you use XML for request and response, the order of the fields are set (often in alphabetical order). The body example in the API method's documentation page should be used. Also, consider using JSON as there are no restrictions regarding order.

API limitations

You should expect more direct API methods to be introduced during , e.g. for creating or updating a single subscriber. However, before this will be added API limitations will be implemented to ensure correct use of the direct API methods. We want to help you get started!

Get started guide

We have created an easy to use "Get started guide" with all the information you need to get started with your API. Go to our start-up guide.

Best Practice

To help you use the right methods for the right purposes, we have created a list of best practices. Go to the best practice guides.

Issues and support

If you need support or help with an API related issue, the fastest way of receiving help is by contacting the APSIS support at supportasia@efficy.com or by phone +852 5804 3550.