zensend/zensend

ZenSend PHP Library

1.0.4 2016-06-15 10:37 UTC

Requires

• php: >=5.3.3
• ext-curl: *
• ext-json: *

Requires (Dev)

• phpunit/phpunit: ~4.6

MIT

• ZenSend

README

ZenSend PHP bindings

You can sign up for a ZenSend account at https://zensend.io.

Requirements

PHP 5.3.3 and later.

Composer

You can install the bindings via Composer. Add this to your composer.json:

{
  "require": {
    "zensend/zensend": "1.0.4"
  }
}

Then install via:

composer install

To use the bindings, use Composer's autoload:

require_once('vendor/autoload.php');

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file.

require_once('/path/to/zensend_php_api/init.php');

Getting Started

Simple usage looks like:

$client = new ZenSend\Client("api_key");
$request = new ZenSend\SmsRequest();
$request->body = "BODY";
$request->originator = "ORIG";
$request->numbers = ["447700000000"];
$result = $client->send_sms($request);
echo $result->numbers;
echo $result->sms_parts;
echo $result->encoding;
echo $result->tx_guid;

Verify Getting Started

After authenticating the user display the verify iframe using the following code:

<?php
  session_start();
  $verify = new ZenSend\Verify("api_key");
  $verify->create_session("441234567890"); // the number you want to verify
  $verify->write_tags("https://" . $_SERVER['HTTP_HOST'] . "/verify_callback.php");
?>

Create another file called verify_callback.php to handle verification:

<?php
  session_start();
  $verify = new ZenSend\Verify("api_key");
  try {
    $verify->verify_response("441234567890");  // the number you want to verify
    // handle verification success
  } catch (Exception $e) {
    // handle verification failed
  }
?>

Documentation

Please see https://zensend.io/public/docs for up-to-date documentation.

Certificate Errors

If you receive errors like:

"SSL certificate problem: unable to get local issuer certificate"

This is likely because your php curl is not set up with a certificate bundle. This can be fixed by following the instructions here: https://support.zend.com/hc/en-us/articles/204159368-PHP-CURL-HTTPS-Error-SSL-certificate-problem-unable-to-get-local-issuer-certificate-

Or alternatively we have included the CA certificates that we require in a bundle which can be used by creating the ZenSend Client like:

$client = ZenSend\Client::newWithHardcodedCA("api_key");

String Encoding

All strings sent to the API should be UTF-8 encoded.

Tests

In order to run tests first install PHPUnit via Composer:

composer update --dev

To run the test suite:

./vendor/bin/phpunit

Manual Testing

~/.composer/vendor/bin/psysh
>>> require('./init.php')
>>> $client = new ZenSend\Client("api_key", array(), "http://127.0.0.1:8084", "http://verify.fonix.dev");
>>> $response = $client->lookup_operator("441234567890");
>>> $client->create_msisdn_verification("441234567890");
>>> $client->msisdn_verification_status("a33d10fe587096a0b70d3701fc2c9f7e")
>>> $verify = new ZenSend\Verify("api_key", array(), "http://verify.fonix.dev");
>>> $verify->create_session("441234567890")
>>> $verify->write_tags("callback");