README

PHP 中的 VBC API SDK。享受吧！

安装

该库使用 Composer 作为其依赖管理器。因此，安装此库遵循 Composers 和 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])

开始创建请求流程并向应用程序颁发令牌。

参数

data

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

options

帮助创建请求的选项数组

--

verify(string $requestId)

验证请求。

参数

requestId

与指定的请求相对应的 Mongo ObjectId。

--

reject(string $requestId)

拒绝请求。

参数

requestId

与指定的请求相对应的 Mongo ObjectId。

--

list()

... 尚未提供

--

客户端

__constructor(array $config)

创建指向 API 网址的 GuzzleHttp 客户端。

参数

config

帮助创建 GuzzleHttp 客户端的数据数组

--

getInstance()

__constructor 的静态别名。

--

步骤有效负载示例

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

许可证

MIT 许可证 (MIT)

版权所有 (c) 2014 Incube8

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

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、针对特定目的的适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该索赔、损害或其他责任是基于合同、侵权或其他方式，源于、因之而引起或与此相关软件或软件的使用或其他交易。