iconneqt/rest-api-client

A PHP class library for the iConneqt REST API.

iConneqt REST API PHP Client

Version 1.0.6, _(*1)

A PHP class library for the iConneqt REST API., _(*2)

, _(*3)

Copyright © 2016-2017 Advanced CRMMail Technology B.V., _(*4)

Documentation

The API documentation can be found here: http://demo.iconneqt.nl/api/docs/., _(*5)

Installation

Either use the included autoloader in src/autoloader.php or install using Composer:, _(*6)

composer require iconneqt/rest-api-client

Classes

Class hierarchy in the src directory., _(*7)

If you use Composer, you can add the src to the autoloader as such:, _(*8)

/* @var $loader Composer\Autoload\ClassLoader */
$loader = require 'path-to-vendor/autoload.php';
$loader->add('Iconneqt', 'path-to-src');

The two most important classes are the following:, _(*9)

\Iconneqt\Api\Rest\Iconneqt

High-level access to the iConneqt REST API, returning rich objects from which you can explore/dive into the API further., _(*10)

Method calls to the Iconneqt class return objects where properties can be accessed using getters and further objects can be queried from the REST API., _(*11)

Alternatively, you can just use the Iconneqt class directly., _(*12)

\Iconneqt\Api\Rest\Client\Client

Low-level API access component used internally by the Iconneqt class., _(*13)

Essentially, this class is a somewhat generic wrapper for cURL lightly tuned for the iConneqt REST API., _(*14)

You may want to use this class if you want to use all available functionality the REST API has to offer or want to bypass the use of objects., _(*15)

Method calls to the Client class return stdClass objects by default, but can be set to return associative arrays instead., _(*16)

Examples

Examples in the example directory., _(*17)

Authentication for examples

• Copy the file auth.example.ini to auth.ini.
• Put your iConneqt username and password in the new file.
• If you are on a different server from demo.iconneqt.nl, change the URL in the auth.ini file accordingly.

Examples

• check_email demonstrates a simple form to check if an email address exists on a given list. Start with this example as an introduction to the Iconneqt class.
• form shows a dynamic form to add new subscribers to a list.
• low-level demonstrates using the Client class directly.