Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 3.06 KB

README.md

File metadata and controls

128 lines (99 loc) · 3.06 KB
Raw

#PHPLIST API REST API as a plugin to PHPlist

Two plugins inside this repo: "api" and "api-test"

Development by Flowcom AB, Andreas Ek (@EkAndreas)

License: GPLv2

##History

v.      Date        Description
0.2.4   2012-12-29  API-location "coderoot" dynamically routed, recommended by Bramley
0.2.3   2012-12-29  Corrections to static calls, recommended by Bramley
0.2.2   2012-12-29  Some more documentation added
0.2.1   2012-12-29  Documentation generator started
0.2     2012-12-28  Slim Framework removed
0.1     2012-12-26  Created

##Installation ###1. Activate plugins in PHPlist Change the config-parameter for plugin folder in /config/config.php. Eg,

define("PLUGIN_ROOTDIR","/var/www/yoursite.com/plugins");

###2. Copy plugin files Copy the files under "plugins" to the plugins folder!, eg /admin/plugins/ Eg,

/var/www/yoursite.com/plugins

###3. Log in Log in to /admin and there should be two menues added; "api" and "api test".

Click on left admin menu "api" for more information!

###4. Test Click on "api test" to test your installation of the API plugin!

##Access Autentication required as admin in PHPlist.

All requests to the API is made by method POST.

Example of API-Url:

http://www.yoursite.com/lists/admin/?page=call&pi=api

First login to PHPlist with POST method and body parameters: "login" and "password".

##Client To try the API, please use a client like CocaRestClient or eqvivalent!

There is an example class in api-test/phplist_api_helper.php if you like to try it in PHP.

For examples check commands in api-test/main.php

##Standard reponse All responses is returned in json and encoded to UTF-8.

Success response from the API

{
  "status":"success",
  "type":"List",
  "data":[{
    "id":"12",
    "name":"A new list in PHPlist"
  }]
}

Error response from the API

{
  "status":"error",
  "type":"Error",
  "data":[{
    "code":"123",
    "message":"Error when creating list"
  }]
}

##Example in PHP The following code log

<?php

$url = 'http://www.yoursite.com/lists/admin/?page=call&pi=api';

//initialize cUrl for remote content
$c = curl_init();
curl_setopt( $c, CURLOPT_COOKIEFILE, 'PHPlist_API_Helper' ); 
curl_setopt( $c, CURLOPT_COOKIEJAR, 'PHPlist_API_Helper' ); 
curl_setopt( $c, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $c, CURLOPT_POST, 1 );

//Call for the session-id via /login 
curl_setopt( $c, CURLOPT_URL, $url );
curl_setopt( $c, CURLOPT_POSTFIELDS, 'cmd=login&login=admin&password=phplist' );
$result = curl_exec( $c );
$result = json_decode( $result );
var_dump( $result->data ); 

//Get all lists in PHPlist via /listsGet 
curl_setopt( $c, CURLOPT_URL, 'http://www.yoursite.com/lists/admin/?page=call&pi=api' );
curl_setopt( $c, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $c, CURLOPT_POST, 1 );
curl_setopt( $c, CURLOPT_POSTFIELDS, 'cmd=listsGet' );
$result = curl_exec( $c );
$result = json_decode( $result );

//Now close the cUrl when finished 
curl_close( $c );

//Dump all lists in PHPlist via /listsGet 
var_dump( $result->data );

?>