README

api-taxi-yandex

用于通过Yandex.Такси API与停车场合作伙伴进行交互的PHP库，包含额外的方法。

安装

可以使用Composer包管理器进行安装

$ composer require webazon/api-taxi-yandex

或从GitHub下载包

初始化

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

$parkId = 'ВАШ_ИД_ПАРКА';
$apiKey = 'ВАШ_API_КЛЮЧ';

$client = new Webazon\ApiTaxiYandex\Client($parkId,$apiKey);

请求响应

任何请求的响应都包含一个格式为的对象

headers (对象) - 服务器响应头
- http (对象)
  - protocol (字符串) - 协议
  - result_code (整数) - 服务器响应代码
  - message (字符串) - 消息
- content-length (整数) - 响应体大小
- content-type (字符串)
- date (字符串)
- vary (字符串)
- x-yarequestid (字符串) - Yandex系统中的请求ID

body (对象) - 根据官方文档描述的自定义响应体

Yandex服务器响应代码

返回在响应体中

{
 headers: {
     	  http: {
                result_code: "код ответа"
          	    }
 		  }
}

如果响应代码不同于200，则响应体将包含错误消息，格式为

{"message": "поле с сообщением об ошибке"}

限制

使用API时存在限制

每秒不超过2个请求
每小时不超过5000个请求

超过限制时，将返回429 Too Many Requests代码。

可用的方法列表

汽车

汽车列表

官方文档中的API方法

object all ( [object $fields] ,[object $query], [ int $offset ], [ int $limit ] )

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

可选参数列表

fields - 需要提取的数据

query - 搜索限制

offset - 从中返回汽车的位置偏移量

limit - 响应中汽车的限制

司机

所有司机资料的列表

官方文档中的API方法

array all ( [array $fields] ,[array $query], [ int *$offset ], [ int $limit ] )

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

可选参数列表

fields - 需要提取的数据

query - 搜索限制

offset - 从中返回司机的位置偏移量

limit - 响应中司机的限制

此外，在"balances"字段中返回所有司机的总余额，这对于维持停车场必要的存款余额以确保向司机支付至关重要。

通过电话号码和（或）姓名和（或）驾照号搜索司机资料。

搜索仅限于具有"work_status" => "working"值的在职司机。

array search ([object $query])

$driver = $client->api('drivers')->search($query);

参数列表（必须指定参数之一）

$query = [
    	'phones' => ['+79056385411'],

		'name' => 'ФИО',

		'license' => ''	

        ];

返回包含司机资料的对象，如果司机未找到，则返回404。

项目处于开发阶段。新的方法将随着实施而出现。

许可证

© 2022 ИП Кацеф Алексей Михайлович

本文件向任何获得本软件及其相关文档文件（以下简称“软件”）副本的个人提供免费许可，允许其在软件中使用，不受限制，包括但不限于复制、修改、合并、发布、分发、再许可和/或销售软件副本，以及允许他人在此条件下使用软件：上述版权声明和本许可声明应包含在软件的所有副本或重要部分中。软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于商业性、特定用途适用性和不侵犯他人权利的保证。在任何情况下，作者或版权所有者不承担任何索赔、损害或其他责任。无论基于合同、侵权或其他原因，由于软件、使用或与其他交易而产生的责任，作者或版权所有者均不承担责任。

webazon/api-taxi-yandex

维护者

详情