README

api-taxi-yandex

PHP библиотека для парков-партнёров по взаимодействию через API Яндекс.Такси с дополнительными методами.

Установка

Можно установить используя менеджер пакетов Composer

$ composer require webazon/api-taxi-yandex

или скачать пакет с GitHub

Инициализация

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

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

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

Ответ на запрос

В ответе на любой запрос содержится объект формата:

headers (object) - заголовок ответа сервера
- http (object)
  - protocol (string) - протокол
  - result_code (integer) - код ответа сервера
  - message (string) - сообщение
- content-length (integer) - размер тела ответа
- content-type (string)
- date (string)
- vary (string)
- x-yarequestid (string) - ID запроса в системе Яндекс
body (object) - само тело ответа в соответсвии с описанием в оф.документации

Коды ответа от сервера Яндекс

возвращаются в теле ответа
```
{
 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 , если водитель не найден.

Проект находится в разработке. Новые методы будут появляться по мере реализации.

License

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

Настоящим предоставляется бесплатное разрешение любому лицу, получившему копию данного программного обеспечения и связанных с ним файлов документации ("Программное обеспечение"), использовать в Программном обеспечении без ограничений, включая, помимо прочего, права копировать, изменять, объединять, публиковать, распространять, сублицензировать и/или продавать копий Программного обеспечения, а также разрешить лицам, которым Программное обеспечение предоставляется для этого при соблюдении следующих условий: Вышеприведенное уведомление об авторских правах и это уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения. ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕТСЯ, ВКЛЮЧАЯ, ПОМИМО ПРОЧЕГО, ГАРАНТИИ КОММЕРЧЕСКОЙ ЦЕННОСТИ, ПРИГОДНОСТЬ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЕ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ВЛАДЕЛЕЦ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТЬ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УЩЕРБ ИЛИ ДРУГОЕ. ОТВЕТСТВЕННОСТЬ, БУДУЩАЯ ПО ДОГОВОРУ, ДЕЛИКТУ ИЛИ ИНЫМ ОБРАЗОМ, ВОЗНИКАЮЩАЯ ИЗ, ВНЕ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ В ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ.

webazon / api-taxi-yandex

Maintainers

Details