jlorente/connectus-php-sdk

A PHP package to access the Connectus API by a comprehensive way.

1.0.2 2021-08-10 08:59 UTC

This package is auto-updated.

Last update: 2024-12-10 16:05:35 UTC


README

A PHP package to access the Connectus API by a comprehensive way.

Installation

The preferred way to install this extension is through composer.

With Composer installed, you can then install the extension using the following commands:

$ php composer.phar require jlorente/connectus-php-sdk

or add

...
    "require": {
        "jlorente/connectus-php-sdk": "*"
    }

to the require section of your composer.json file.

Configuration

You can set the api keys as environment variables or add them later on Connectus class instantiation.

The name of the environment variables are CONNECTUS_API_KEY and CONNECTUS_ACCOUNT_ID.

Usage

Endpoints calls must done through the Connectus class.

If you haven't set the environment variables previously, remember to provide them on instantiation.

$connectus = new \Jlorente\Connectus\Connectus($apiKey, $apiSecret);
$connectus->api()->checkSmsBalance();

All the API methods are well documented in the Jlorente\Connectus\Api class.

License

Copyright © 2021 José Lorente Martín jose.lorente.martin@gmail.com.

Licensed under the BSD 3-Clause License. See LICENSE.txt for details.