README

Currencycloud API v2 PHP客户端

版本：0.10.0

这是Currencycloud API的官方PHP SDK。每个API端点的附加文档可以在developer.currencycloud.com找到。

如果您有任何疑问或需要支持，请通过sales@currencycloud.com联系我们的销售团队。请在任何通信中引用您的登录ID，这使我们能够更容易地找到您的账户并提供所需的支持。

先决条件

Composer（可选，但强烈推荐）

CurrencyCloud-PHP是一个Composer项目。虽然使用Composer不是强制性的，但使用Composer进行依赖管理和自动加载会更容易。

支持的PHP版本

此库旨在支持并已针对PHP 5.5及以上版本进行测试。

安装

安装Currencycloud SDK的推荐方法是通过Composer。

如果您尚未安装Composer，请查看Composer安装指南。

假设您已全局安装Composer，您可以通过执行以下操作将Currencycloud SDK要求添加到您的项目中

composer require currency-cloud/client

安装后，如果您之前没有要求，则需要要求Composer的自动加载器

require 'vendor/autoload.php';

用法

您可以在developer.currencycloud.com注册demo API密钥。

PHP 5.5的一个示例

use CurrencyCloud\CurrencyCloud;
use CurrencyCloud\Session;

require_once __DIR__ . '/vendor/autoload.php';

$session = new Session(
    Session::ENVIRONMENT_DEMONSTRATION,
    '<user-id>',
    '<api-key>'
);

$client = CurrencyCloud::createDefault($session);

//Authenticate
$client->authenticate()
    ->login();

//Get available currencies
$currencies =
    $client->reference()
        ->availableCurrencies();

echo "Supproted currencies:\n";

foreach ($currencies as $currency) {
    printf(
        "Currency: %s; Code: %s; Decimal places: %d\n",
        $currency->getName(),
        $currency->getCode(),
        $currency->getDecimalPlaces()
    );
}

echo "Balances:\n";

//Find balances
$balances =
    $client->balances()
        ->find();

foreach ($balances->getBalances() as $balance) {
    printf(
        "Balance ID: %s; Currency: %s; Amount: %s\n",
        $balance->getId(),
        $balance->getCurrency(),
        $balance->getAmount()
    );
}

//Close session
$client->authenticate()->close();

对于更长的示例，请参阅cook-book.php，这是文档中食谱的实现。

常见模式

为多个请求重用客户端

身份验证令牌是长期有效的，并旨在用于多个请求。这将提高通过API的调用性能。

代表他人

如果您想代表其他用户进行调用（例如，您的最终客户），您可以执行某些命令“代表”用户的联系ID。以下是一个示例

$client->onBehalfOf('c6ece846-6df1-461d-acaa-b42a6aa74045', function (CurrencyCloud $client) {
    $balances =
        $client->balances()
            ->find();

    foreach ($balances->getBalances() as $balance) {
        printf(
            "Balance ID: %s; Currency: %s; Amount: %s\n",
            $balance->getId(),
            $balance->getCurrency(),
            $balance->getAmount()
        );
    }
});

上述每个交易都将在此联系人的范围内执行，并与其相关联。请注意，执行交易的实际用户也将被存储。

错误

当API发生错误时，库旨在尽可能多地提供信息。将抛出包含许多有用信息的CurrencyCloudException，您可以通过其方法访问这些信息。当异常转换为字符串时，它将提供如下信息

BadRequestException
---
platform: 'PHP 5.6.14-1+deb.sury.org~trusty+1'
request:
    parameters: {  }
    verb: get
    url: 'https://devapi.currencycloud.com/v2/rates/detailed?buy_currency=EUR&sell_currency=GBP&fixed_side=buy&amount=10000.00'
response:
    status_code: 400
    date: 'Sun, 06 Nov 2015 18:22:47 GMT'
    request_id: '2915002181730358306'
errors:
    -
        field: base
        code: rate_could_not_be_retrieved
        message: 'Rate could not be retrieved'
        params: {  }

这分为5个部分

错误类型：在这种情况下，BadRequestException代表HTTP 400错误
平台：在客户端中使用的PHP实现
请求：有关已执行的HTTP请求的详细信息，例如POST参数
响应：有关返回的HTTP响应的详细信息，例如HTTP状态代码
错误：提供附加信息的错误列表

最后一节包含有价值的信息

字段：错误关联的参数
代码：代表此错误的代码
信息：解释错误的可读性信息
参数：包含错误信息动态部分的映射，用于构建自定义错误信息

当与Currencycloud支持进行API调用故障排除时，在任何通讯中包含完整的错误信息可能非常有帮助。

开发

测试

测试用例可以用vendor/bin/phpunit运行。

依赖关系

版本管理

本项目使用语义版本控制。您可以安全地表达对主要版本的依赖，并期望所有次要和补丁版本都是向后兼容的。

max-currency-cloud / client

维护者

详细信息