kozap/ontraport-php-sdk

Ontraport PHP SDK

0.1.9 2015-11-05 05:27 UTC

This package is not auto-updated.

Last update: 2024-09-28 18:16:03 UTC


README

Examine.com开发

ontraport-php-sdk

新 ONTRAPORT API 的 SDK

使用 Guzzle 5.3

基于以下位置的原始文档: https://api.ontraport.com/doc/

composer 是安装 SDK 的推荐方式。

它可在 https://packagist.org.cn 上找到。要在项目中使用它,您需要在项目的 composer.json 文件中将其作为依赖项包括。

安装

  1. 如果尚未安装,请下载 Composer

  2. 转到您的项目目录。如果没有,只需创建一个目录并 cd 进入。

    
    

mkdir project cd project

```sh

在命令行中执行 composer require "kzap/ontraport-php-sdk:*" 。如有必要,将 composer 替换为 composer.phar。它应该显示类似以下内容

composer require "kzap/ontraport-php-sdk:*"

  • 加载 composer 存储库和包信息 更新依赖关系(包括 require-dev)

安装 kzap/ontraport-php-sdk (0.1) 从缓存加载

写入锁定文件 生成自动加载文件

  1. 确保您已在 bootstrap 文件或主 PHP 文件中自动加载 Composer

    
    

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

```php

在您的类或 PHP 文件中,包含类的命名空间

```php

use Kzap\Ontraport\Api\Sdk as OntraportSdk;

```php

在构造函数或您想要实例化/使用 API 的任何地方,创建类的实例,并将您的 APP_IDAPI_KEY 作为参数

$this->ontraportSdk = new OntraportSdk("{APP_ID}", "{API_KEY}");

<?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);