nysschens/tradeapp-api-client

适用于交易平台的PHP Guzzle API客户端

dev-main 2020-12-01 17:03 UTC

This package is auto-updated.

Last update: 2024-09-25 19:17:01 UTC


README

一个用于Laravel消耗交易平台数据的PHP Guzzle API客户端的骨架仓库。

TradeApp是一个使用Guzzle 7的独立API客户端,旨在消耗来自各种全球交易平台的数

安装

当然,您可以使用Composer进行安装。

$ composer require nysschens/tradeapp-api-client

使用方法

首先,您需要创建一个客户端对象来连接到交易平台服务器。您需要从您订阅的任何交易平台获取API用户名和密码。请向您的经纪人询问此信息。然后,将凭据传递到客户端对象以登录,如下所示。

$client = new \TradeApp\ApiClient("https://<username>:<password>@<hostname>");

假设您的凭据有效,您可以继续操作!

获取国家列表

/** @var \TradeApp\Responses\Country[] $countries */
$countries = $client->countries();

注册新客户

$request = new TradeApp\Requests\Register([
    'firstName' => 'John',
    'lastName' => 'Smith',
    'email' => 'john.smith@gmail.com',
    'confirmed' => 1,
    'password' => 'qwerty',
    'phone' => '+123456789',
    'country' => 'gb',
    'locale' => 'en-GB',
    'params' => [],
    'lead' => 0,
]);

/** @var \TradeApp\Responses\Register $response */
$response = $client->register($request);

以用户身份登录

$request = new \TradeApp\Requests\Login([
    'email' => 'nysschens@gmail.com',
    'password' => 'qwerty',
]);

/** @var \TradeApp\Responses\Login $response */
$response = $client->login($request);

获取用户信息

$request = new \TradeApp\Requests\Login([
    'email' => 'john.smith@gmail.com',
    'password' => 'qwerty',
]);

/** @var \TradeApp\Responses\UserInfo $response */
$response = $client->getUserInfo($request);

运行测试

通过PHPUnit运行单元测试

$ vendor/bin/phpunit tests

注意:使用以下命令为此包安装开发依赖项

$ composer update --dev