Purpose

Please see the newer phpList REST API which is included by default in phpList 3.4.0+

It provides a REST API interface to phpList.

This is the continuation of the original REST API plugin by Andreas Ek

If you use this plugin, please sign up to the phpList RestAPI list so that you can be informed of changes.

IMPORTANT: If you have used the API previous to November 2015, you will need to be careful to upgrade to the latest version. A lot has changed in the API, and if you make calls on the old API, they are likely to fail.

Configuration

The plugin will add the following entries to the Settings page of phpList

Maximum number of RESTAPI requests per minute - will restrict the use of the API

Require SSL on Rest API calls - will enforce the URL to be on SSL. This only works if your phpList installation can be accessed via SSL

IP Address that is allowed to access the API - if you only access the phpList system from one IP address, you can use this to prevent unauthorised access attempts

Require the secret code for Rest API calls - Set this to YES to require the API calls to include the secret (Secret for remote processing). You will need to update your client class to include the secret.

Development

The current state of the plugin allows for simple calls to manipulate lists, subscribers, campaigns and templates.

Future developments will go towards a joint effort of the phpList4 project and the phpList RESTAPI plugin. Work on this has already started in the “restapi2” part of this plugin, but is still in progress.