README

这是一个简化与Publish Interactive RESTful API交互的包。此包不管理发送到API的数据或从API接收的数据。最好将此包视为一个“辅助”包，用于向GET、POST、PUT和DELETE端点发送请求。

安装

要求

• PHP 5.4.0
• Composer

安装composer依赖

composer install

这就完成了！

使用

基本用法

use FourFiveOne\PublishInteractive\API\API;

...

$username = 'username';
$password = 'password';
$url      = 'https://mysite.publishinteractive.com/api/v1';

$api = new API($username, $password, $url);

...

$parameters = [
    'includeHidden'      => true,
    'includeDescendants' => true,
];

$response = $api->get('categories', $parameters);

if ($response['response_code'] == 200) {
    ...
} else {
    ...
}

以下REST动词可用

• GET
• POST
• PUT
• DELETE

以下函数可用于特定用例

attachment() - 将附件上传到报告。

所有函数都返回以下数组

$response['response_code'] // the http response code
$response['data']          // the JSON data returned as an associative array

测试

要运行测试，您需要在根目录中创建一个.env文件。有一个.env.example示例文件供您开始。该文件需要用户名、密码和连接到您的PI实例并运行测试的URL。

运行测试

./vendor/bin/phpunit