README

Yo PHP SDK 是 Yo API 服务 的官方 SDK 封装

要求

• PHP 版本 5.3.0+

安装

使用以下命令安装最新版本

$ composer require yopify/yo-php-sdk

手动用户安装

下载 src/Yo/Client.php 并将其包含到您的 PHP 项目中。

查看我们的示例 example/example.php，快速使用示例

基本用法

通过以下方式初始化 Yo 客户端

<?php
use Yopify\Yo\Client;
$yoClient = new Client();

$yoClient->authToken = 'YOUR-TOKEN-HERE'; // auth token can be found here: https://yopify.com/api/yo/settings#/api

// OR

$yoClient->setBasicAuth('me@mysite.com', 'secret'); // You can use basic auth also

#####检查认证

$isAuthenticated = $yoClient->ping(); // false if not authenticated, current timestamp if success

#####获取单个事件

$event = $yoClient->getEvent(EVENT_ID);

#####获取事件列表

$events = $client->getEvents(PER_PAGE, PAGE_NO);

// Check for success
if (isset($events->meta)) {
    echo 'Current page: ', $events->meta->pagination->current_page, "\n";
    echo 'Total pages: ', $events->meta->pagination->total_pages, "\n";
    echo 'Page page: ', $events->meta->pagination->per_page, "\n";
    echo 'Total count: ', $events->meta->pagination->total, "\n";
}

#####创建新事件

$event = new Yopify\Yo\YoEvent();
$event->event_type_id = '1';
$event->unique_id1 = '10';
$event->unique_id2 = '1';
$event->title = 'This awesome product';
$event->first_name = 'Jon';
$event->last_name = 'snow';
$event->city = 'New York';
$event->province = 'XXXX';
$event->country = 'USA';
$event->url = 'https://example.com';
$event->message_template = '[FIRST-NAME] from [COUNTRY] just purchased [TITLE-WITH-LINK]';
$yoEvent = $yoClient->createEvent($event);

#####更新事件

$yoEvent = $yoClient->getEvent(EVENT_ID);

if (isset($yoEvent->data)) {
    $yoEvent = $yoEvent->data;
    $yoEvent->province = "AAAA";

    $updatedEvent = $yoClient->updateEvent($yoEvent);
}

#####删除事件

$deletedEvent = $yoClient->deleteEvent(EVENT_ID);

支持

如果您有任何问题，请通过电子邮件发送到 yo@yopify.com。