README

About phpList

phpList is an open source newsletter manager.

About this package

This module is the REST API for phpList 4, providing functions for superusers to manage lists, subscribers and subscriptions via REST calls. It uses functionality from the phplist/core module (the phpList 4 core). It does not contain any SQL queries, uses functionality from the new core for DB access.

This module is optional, i.e., it is possible to run phpList 4 without the REST API.

This new REST API can also be used to provide REST access to an existing phpList 3 installation. For this, the phpList 3 installation and the phpList 4 installation with the REST API need to share the same database. For security reasons, the REST APIs from phpList 3 and phpList 4 should not be used for the same database in parallel, though.

Installation

Please install this package via Composer from within the phpList base distribution, which also has more detailed installation instructions in the README.

API Documentation

Visit /docs endpoint to access the full interactive documentation for phpList/rest-api.

Look at the "API Documentation with Swagger" section in the contribution guide for more information on API documenation.

Local demo with Postman

You can try out the API using pre-prepared requests and the Postman GUI tool. Install Postman as a browser extension or stand-alone app, open the phpList 4 REST API Demo collection and click "Run in Postman".

Contributing to this package

Please read the contribution guide on how to contribute and how to run the unit tests and style checks locally.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

phplist / rest-api

Maintainers

Details