README

PHP的Buffer API库客户端

此库是由alpaca生成的

安装

请确保您已安装composer。

将以下内容添加到您的composer.json文件中

{
    "require": {
        "pksunkara/buffer-alpaca": "*"
    }
}

更新依赖项

$ php composer.phar update

此软件包遵循其类的PSR-0命名约定，这意味着您可以将这些类轻松集成到自己的自动加载器中。

版本

兼容[ 5.4 / 5.5 ]

使用

<?php

// This file is generated by Composer
require_once 'vendor/autoload.php';

// Then we instantiate a client (as shown below)

构建客户端

在不进行身份验证的情况下使用此API将引发错误

OAuth访问令牌

$client = new Buffer\Client('1a2b3', $clientOptions);

OAuth客户端密钥

$auth = array('client_id' => '09a8b7', 'client_secret' => '1a2b3');

$client = new Buffer\Client($auth, $clientOptions);

客户端选项

在实例化客户端时，以下选项可用

• base: API的基础URL
• api_version: API的默认版本（用于URL中）
• user_agent: 所有请求的默认user-agent
• headers: 所有请求的默认头部
• request_type: 请求体的默认格式
• response_type: 响应的默认格式（用于URL后缀中）

响应信息

提供给API调用的所有回调都将接收以下所示的响应

$response = $client->klass('args')->method('args', $methodOptions);

$response->code;
// >>> 200

$response->headers;
// >>> array('x-server' => 'apache')

JSON响应

当服务器发送的响应为json时，它将被解码为数组

$response->body;
// >>> array('user' => 'pksunkara')

方法选项

调用API方法时，以下选项可用

• api_version: API版本（用于URL中）
• headers: 请求的头部
• query: URL的查询参数
• body: 请求体
• request_type: 请求体的格式
• response_type: 响应的格式（用于URL后缀中）

请求体信息

在选项中设置request_type以相应地修改体

原始请求

当值设置为raw时，不要修改体。

$body = 'username=pksunkara';
// >>> 'username=pksunkara'

表单请求

当值设置为form时，对体进行urlencode。

$body = array('user' => 'pksunkara');
// >>> 'user=pksunkara'

信息API

返回API实例以获取创建您的应用程序时有用的有关Buffer的辅助信息。

$info = $client->info();

服务和配置（GET /info/configuration）

返回一个对象，其中包含Buffer当前使用的配置，包括支持的服务、它们的图标以及字符和时间的不同限制。

$response = $info->show($options);

认证用户API

返回认证用户API实例。

$user = $client->user();

用户信息（GET /user）

返回有关认证用户的信息。

$response = $user->show($options);

用户社交媒体配置文件列表（GET /profiles）

返回一个数组，其中包含连接到认证用户账户的社交媒体配置文件。

$response = $user->profiles($options);

创建社交媒体更新（POST /updates/create）

创建一个或多个新的状态更新。

以下参数是必需的

• text：状态更新文本。
• profile_ids：应发送状态更新的配置文件ID数组。无效的profile_id将被静默忽略。

$response = $user->createUpdate("This is an example update", array(
    "4eb854340acb04e870000010",
    "4eb9276e0acb04bb81000067"
), $options);

链接API

返回用于获取通过Buffer共享的链接信息的API实例。

$link = $client->link();

链接分享数量（GET /link/shares）

返回一个对象，其中包含使用Buffer分享的链接的分享次数。

以下参数是必需的

• url：请求分享次数的页面的URL。

$response = $link->shares("http://bufferapp.com", $options);

社交媒体配置文件API

返回社交媒体配置文件API实例。

以下参数是必需的

• id：社交媒体配置文件的标识符

$profile = $client->profile("519fc3ca4d5e93901900002f");

获取此社交媒体配置文件（GET /profiles/:id）

返回指定社交媒体配置文件的详细信息。

$response = $profile->show($options);

列出配置文件的待处理更新（GET /profiles/:id/updates/pending）

返回一个数组，其中包含当前缓冲区中单个社交媒体配置文件的更新。

$response = $profile->pending($options);

列出配置文件的已发送更新（GET /profiles/:id/updates/sent）

返回一个数组，其中包含已从缓冲区发送的单个社交媒体配置文件的更新。

$response = $profile->sent($options);

编辑配置文件的更新顺序（POST /profiles/:id/updates/reorder）

编辑指定社交媒体配置文件将发送的状态的顺序。

以下参数是必需的

• order：按顺序排列的状态更新ID数组。这可以与offset参数组合使用部分数组，或者使用包含配置文件Buffer中每个更新的完整数组。

$response = $profile->reorder(array(
    "4eb854340acb04e870000010",
    "4eb9276e0acb04bb81000067",
    "4eb2567e0ade04ba51000001"
), $options);

随机配置文件的更新顺序（POST /profiles/:id/updates/shuffle）

随机指定社交媒体配置文件将发送的状态的顺序。

$response = $profile->shuffle($options);

发布计划API

返回社交媒体配置文件的调度API实例。

以下参数是必需的

• id：社交媒体配置文件的标识符

$schedule = $client->schedule("519fc3ca4d5e93901900002f");

获取配置文件的发布计划（GET /profiles/:id/schedules）

返回与社交媒体个人资料关联的发布时间表的详细信息。

$response = $schedule->list($options);

更新个人资料的发布时间表（POST /profiles/:id/schedules/update）

设置指定社交媒体个人资料的发布时间表。

以下参数是必需的

• 时间表：数组中的每个项都是一个单独的发布时间表，由天数和匹配上述方法返回的格式的时辰组成。

$response = $schedule->update(array(
    array(
        'days' => array(
            "mon",
            "tue",
            "thu"
        ),
        'times' => array(
            "12:45",
            "15:30",
            "17:43"
        )
    )
), $options);

社交更新API

返回一个社交媒体更新API实例。

以下参数是必需的

• id：社交媒体更新的标识符

$update = $client->update("4eb8565e0acb04bb82000004");

获取此社交更新（GET /updates/:id）

返回单个社交媒体更新。

$response = $update->show($options);

列出更新的互动（GET /updates/:id/interactions）

返回有关与社交媒体更新互动的详细信息，例如收藏、转发和点赞。

$response = $update->interactions($options);

编辑此更新（POST /updates/:id/update）

编辑现有的单个状态更新。

以下参数是必需的

• text：状态更新文本。

$response = $update->update("This is an edited update", $options);

分享此更新（POST /updates/:id/share）

立即分享单个待处理更新，并重新计算队列中剩余更新的时间。

$response = $update->share($options);

删除此更新（POST /updates/:id/destroy）

永久删除现有的状态更新。

$response = $update->destroy($options);

将此更新移动到顶部（POST /updates/:id/move_to_top）

将现有的状态更新移动到队列的顶部，并重新计算队列中所有更新的时间。返回带有其新发布时间的更新。

$response = $update->top($options);

贡献者

以下是一个贡献者列表。

待办事项

许可

MIT

错误报告

在此处报告。

联系

Pavan Kumar Sunkara (pavan.sss1991@gmail.com)