slmatthew / vk-coin
VK Coin API
dev-master
2019-04-15 14:57 UTC
Requires
- php: >=5.5.5
This package is auto-updated.
Last update: 2019-04-15 15:29:07 UTC
README
我编写了一个用于操作VK Coin API的框架。希望不会出错。
响应格式
调用函数getTransactions()
或sendTransfer()
返回一个包含两个字段或false的数组。
字段名 | 类型 | 描述 |
---|---|---|
status | bool | true ,如果请求成功。 false ,如果发生错误 |
response | array | 只有在status == true 时返回。 包含API响应的数组。 |
error | string | 只有在status == false 时返回。 描述CURL错误的字符串。 |
如果发生错误,将返回false
。可以通过以下方式进行检查
$result = $vkcoin->getTransactions(); if($result === false) { // что-то пошло не так } elseif($result['status']) { // запрос выполнен успешно } else { // обработка ошибки CURL }
注意! 可以通过$result['response']
获取API响应,如果响应如下
{ "status": true, "response": { "response": { "1": 92696964157 } } }
以前需要写
$result['response']['response']
。要理解我写的内容,最好查看代码中的request()
函数。
初始化
示例
include './lib.php'; $vkcoin = new VKCoinClient(305360617, 'cNwFTVP7Y33M5TxgZMhLQmdcNrb6qu72mNCTeRdX9PVEqbJPpe');
参数 | 类型 | 必需? | 描述 |
---|---|---|---|
merchant_id | int | 是 | 获得支付密钥的页面ID |
apikey | string | 是 | 支付密钥 |
获取交易列表
示例
$vkcoin->getTransactions(); $vkcoin->getTransactions(2); $vkcoin->getTransactions(1, 200);
参数 | 类型 | 必需? | 描述 |
---|---|---|---|
tx_type | int | 否 | 见文档 |
last_tx | int | 否 | 最后交易号 |
转账
示例
$vkcoin->sendTransfer(305360617, 15000);
参数 | 类型 | 必需? | 描述 |
---|---|---|---|
to_id | int | 是 | 接收转账的用户ID |
amount | int | 是 | 转账金额(千分之几,例如15表示0.015个币) |
获取余额
示例
$vkcoin->getBalance(array(2050, 54986442)); $vkcoin->getBalance([1, 2]);
参数 | 类型 | 必需? | 描述 |
---|---|---|---|
user_ids | array | 是 | 见文档 |
获取支付链接
示例
$vkcoin->generatePayLink(15000); $vkcoin->generatePayLink(15000, 123456); $vkcoin->generatePayLink(15000, 0, false);
参数 | 类型 | 必需? | 描述 |
---|---|---|---|
sum | int | 是 | 转账金额 |
payload | int | 否 | 有效负载,任何从-2000000000到2000000000的数字。如果为0,则将生成一个随机数 |
fixed_sum | bool | 否 | 金额是否固定?见文档 |
use_hex_link | bool | 否 | 是否使用hex值生成链接 |