Download the PHP package phplist/rest-api without Composer

On this page you can find all versions of the php package phplist/rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package rest-api

phpList 4 REST API

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

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.

All versions of rest-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2|^8.0
phplist/core Version ^v4.0.0-alpha5
friendsofsymfony/rest-bundle Version ^2.8.6
sensio/framework-extra-bundle Version 5.1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package phplist/rest-api contains the following files

Loading the files please wait ....