README

用于 Yandex.Taxi API 的 PHP 库

安装

您可以使用 Composer

$ composer require ipinchuk/php-yandex-taxi-api

或从 GitHub 下载

用法

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

$clientId = 'YOUR_CLIENT_ID';
$apiKey = 'YOUR_API_KEY';
$parkId = 'YOUR_PARK_ID';

$client = new IPinchuk\YandexTaxi\Client($clientId, $apiKey, $parkId);

车辆

获取车辆列表

查看 API 方法文档

$cars = $client->api('cars')->all();

司机档案

获取司机档案列表

查看 API 方法文档

$cars = $client->api('drivers')->all();

更改与司机档案和车辆的关联

查看 API 方法文档

$profile_id = "SOME_DRIVER_PROFILE_ID";
$car_id = "SOME_CAR_ID";

$cars = $client->api('drivers')->bindVehicle($profile_id, $car_id);

移除司机档案与车辆的关联

查看 API 方法文档

$profile_id = "SOME_DRIVER_PROFILE_ID";
$car_id = "SOME_CAR_ID";

$cars = $client->api('drivers')->unbindVehicle($profile_id, $car_id);

司机工作规则

获取工作规则列表。

查看 API 方法文档

$cars = $client->api('rules')->all();

订单

获取订单列表。

查看 API 方法文档

$cars = $client->api('orders')->all();

交易

获取交易列表。

查看 API 方法文档

$cars = $client->api('transactions')->all();

获取交易类别列表。

查看 API 方法文档

$cars = $client->api('transactions')->categories();

获取指定司机的交易列表

查看 API 方法文档

$driver_id = 'SOME_DRIVER_ID';

$cars = $client->api('transactions')->driverTransactions($driver_id);

获取订单的交易列表

查看 API 方法文档

$order_ids = ['ORDER_ID_1', 'ORDER_ID_2', 'ORDER_ID_3'];

$cars = $client->api('transactions')->orderTransactions($order_ids);

创建新的司机交易

查看 API 方法文档

$driver_id = 'SOME_DRIVER_ID';
$amount = '-10'; // You can increase or decrease driver balance
$cad_id = 'SOME_TRANSACTION_CATEGORY_ID';
$description = 'SOME_TRANSACTION_DESCRIPTION';

$cars = $client->api('transactions')->createTransaction($driver_id, $amount, $cad_id, $description);

或

$driver_id = 'SOME_DRIVER_ID';
$amount = '10';
$cad_id = 'SOME_TRANSACTION_CATEGORY_ID';
$description = 'SOME_TRANSACTION_DESCRIPTION';

// For increase balance.
$cars = $client->api('transactions')->increaseBalance($driver_id, $amount, $cad_id, $description);
// For decrease balance
$cars = $client->api('transactions')->decreaseBalance($driver_id, $amount, $cad_id, $description);

添加代理服务器

$client->setProxy('YOR_PROXY_IP');

代码质量

您需要在 ClientTest.php 中配置 API 密钥、客户端 ID 和停车 ID 信息，然后使用 PHPUnit 运行单元测试

$ phpunit tests/

许可

MIT 许可

版权所有 (c) 2020 Igor Pinchuk

在此授予任何人免费获得此软件及其相关文档副本（“软件”）的副本的权利，用于在不附加任何限制的情况下处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向提供软件的人员做上述事情，前提是

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

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