ontraport-php-sdk

SDK for the New ONTRAPORT API, _(*2)

Uses Guzzle 5.3, _(*3)

Based on original documentation located here: https://api.ontraport.com/doc/, _(*4)

composer is the recommended way to install the SDK., _(*5)

It is available at https://packagist.org. To use it in your project, you need to include it as a dependency in your project composer.json file., _(*6)

Installation

Download Composer if not already installed
Go to your project directory. If you do not have one, just create a directory and cd in., _(*7)
```
mkdir project
cd project
```
Execute composer require "kzap/ontraport-php-sdk:*" on command line. Replace composer with composer.phar if required. It should show something like this:, _(*8)

```sh, _(*9)

composer require "kzap/ontraport-php-sdk:*", _(*10)

Loading composer repositories with package information Updating dependencies (including require-dev) - Installing kzap/ontraport-php-sdk (0.1) Loading from cache, _(*11)

Writing lock file Generating autoload files ```, _(*12)

How to use

Make sure you are auto-loading Composer in your bootstrap file or main php file:, _(*13)
```
require_once __DIR__ . '/vendor/autoload.php';
```
In your class or PHP file, include the namespace of the class:, _(*14)
```
use Kzap\Ontraport\Api\Sdk as OntraportSdk;
```
In your constructor or wherever you want to instantiate / use the API, create a new instance of the class and use your APP_ID and API_KEY as the parameters:, _(*15)
```
$this->ontraportSdk = new OntraportSdk("{APP_ID}", "{API_KEY}");
```

Call one of the methods in Sdk.php to access the API:, _(*16)

$parameters = array(
'objectId' => $this->ontraportSdk->getObjectTypeByName('contact'),
);
$jsonResponse = $this->ontraportSdk->getObject($parameters);
var_dump($jsonResponse);

Sample code

<?php

namespace App;

use Kzap\Ontraport\Api\Sdk as OntraportSdk;

require_once __DIR__ . '/vendor/autoload.php';

class OntraportApp
{
    /* Properties
    -------------------------------*/
    private $ontraportSdk = null;

    public function __construct($appId, $apiKey)
    {
        $this->ontraportSdk = new OntraportSdk($appId, $apiKey);
    }

    public function getContacts()
    {
        $parameters = array(
            'objectId' => $this->ontraportSdk->getObjectTypeByName('contact'),
        );
        $jsonResponse = $this->ontraportSdk->getObject($parameters);

        return $jsonResponse;
    }
}

$ontraportApp = new OntraportApp("APP_ID", "API_KEY");
$contacts = $ontraportApp->getContacts();
var_dump($contacts);