README

PHP 中 VBC API 的 SDK。祝你使用愉快！

安装

该库使用 Composer 作为依赖管理器。因此，安装此库遵循 Composer 和 PSR 标准。您可以通过此链接了解更多关于 Composer 的信息：https://getcomposer.org.cn/

在开始之前，您必须创建/更新您的 Composer.json 文件，并将库添加到 require 块中。

...
    "require": {
        "incube8/vbc-sdk": "dev-master"
    }
...

运行 composer update 或 composer install 以将库包含到您的应用程序中

用法

在使用此 SDK 之前，您必须从 VBC 获取 AppKey 和 SecretKey。

<?php
require_once 'vendor/autoload.php';
 
$config = [
    'AppKey' => '',
    'SecretKey' => '',
    'Version' => 'V2' // or V1
];
 
// oop
$client = new Vbc\Client($config);
$request = new Vbc\Request($client);
 
// static
$request = Vbc\Request::factory($config);
 
// create a request
$tokenOrPin = $request->create([
    'uid' => 1234567890,
    'caption' => 'Hi! my name is john from the lovely island of Singapore',
    'data' => [
        'foo' => 'bar'
    ],
    'thumbnail' => 'http://link.to/thumbnail',
    'steps' => [
        'VTYPE_VIDEO' => true,
        'VTYPE_ESIGN' => 'http://link.to/pdf'
    ]
]);
 
print_r($tokenOrPin);

如您所见，有两种方式创建 Vbc\Request 实例：面向对象的方式或静态方式；两者产生相同的结果。

API 参考

请求

create(array $data [, array $options])

开始创建请求的工作流程并向 App 发出令牌。

参数

data

要传递给 API 的数据数组，以帮助创建请求。

key	描述
uid	请求的唯一标识符，可以与您的应用程序关联。
callback	在对此特定用户执行任何操作时，应使用的自定义回调 URL。
caption	用户应在录音窗口中说的标题。
data	要传递回回调的键值对集合。
steps	支持的步骤数组。见下文。自 V2 版本添加。
thumbnail	用户缩略图的 URL。自 V2 版本添加。

options

帮助创建请求的选项数组

key	defaults	描述
auto	true	确定 API 是否应根据请求的用户代理返回链接或 PIN。
pin	false	从 API 返回 PIN。覆盖 auto 标志。

verify(string $requestId)

验证请求。

参数

requestId

与指定请求对应的 MongoDB ObjectId。

reject(string $requestId)

拒绝请求。

参数

requestId

与指定请求对应的 MongoDB ObjectId。

list()

... 目前不可用

客户端

__constructor(array $config)

创建指向API URL的 GuzzleHttp 客户端。

参数

config

一个数组，用于帮助创建 GuzzleHttp 客户端。

key	描述
AppKey	来自已注册应用的 Application Key。
SecretKey	来自已注册应用的 Secret Key。

getInstance()

__constructor 的静态别名。

步骤有效负载示例

{
    "VTYPE_ESIGN": "http://link.to/pdf",
    "VTYPE_VIDEO": true,
    "VTYPE_DOCUMENT": true
}

许可协议

MIT 许可协议 (MIT)

在此特此授予任何获得本软件及其相关文档文件（以下简称“软件”）副本的任何人，免费使用该软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许向软件提供者提供软件的人这样做，前提是遵守以下条件

incube8 / vbc-sdk

维护者

详情

README

安装

用法

API 参考

请求

create(array $data [, array $options])

参数

data

options

verify(string $requestId)

参数

requestId

reject(string $requestId)

参数

requestId

list()

客户端

__constructor(array $config)

参数

config

getInstance()

步骤有效负载示例

许可协议