Спецификация публичного API taxiCRM
Версия 1.13 от 05.07.2022
Общая информация
Все запросы к публичному API taxiCRM выполняются путем передачи JSON с параметрами запроса на адрес интерфейса методом POST.

При обращении к любым интерфейсам данного API в теле запроса всегда должен присутствовать обязательный параметр timestamp, содержащий в себе метку времени, когда запрос к публичному API taxiCRM был создан.

Ответ от API возвращается в JSON, содержащем в себе результат обработки запроса.

Ответ с любым HTTP кодом, отличным от 200 означает ошибку при выполнении запроса.

В случае возникновения ошибок при обработке запроса, текс ошибки будет возвращен в переменной error

Все запросы к публичному API должны быть подписаны с помощью API ключа, который можно найти в настройках taxiCRM (раздел «Компания» > «Настройки компании» > «API»)
Формирование подписи запросов
Подпись запроса необходимо передавать в заголовках запроса в параметре Authorization

Пример:

Authorization: 0ed9166cbb3595ec9bdaf4cbb79b94196d8d8be5

Сама подпись является sha1 хешем полученной из конкатенированной строки, содержащей в себе: «json представление тела запроса» + «API ключ»
Интерфейс #1: регистрация нового пользователя
URL: https://*****.taxicrm.ru/api/public/v1/user/registration
Метод: POST
Параметры запроса
Параметры запроса
Возможные HTTP коды ответа
Обратите внимание!
При регистрации пользователя через публичный API не производится валидация его номера телефона и не осуществляется защита от массовых добавлений пользователей роботами! Все это, если это вам необходимо, вы должны организовать самостоятельно на своей стороне.
Интерфейс #2: Получение списка пользователей
URL: https://*****.taxicrm.ru/api/public/v1/user/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в users_list
Возможные HTTP коды ответа
Интерфейс #3: Получение списка поездок
URL: https://*****.taxicrm.ru/api/public/v1/trip/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в trips_list
Возможные HTTP коды ответа
Интерфейс #4: Получение списка выплат
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в payout_list
Возможные HTTP коды ответа
Интерфейс #5: Получение списка транзакций пользователей
URL: https://*****.taxicrm.ru/api/public/v1/user/transaction/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в transactions_list
Возможные HTTP коды ответа
Интерфейс #6: Получение списка транзакций автомобилей
URL: https://*****.taxicrm.ru/api/public/v1/car/transaction/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в transactions_list
Возможные HTTP коды ответа
Интерфейс #7: Получение баланса пользователя
URL: https://*****. taxicrm.ru/api/public/v1/user/balance/get
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #8: Получение списка смен
URL: https://*****.taxicrm.ru/api/public/v1/shifts/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в shifts_list
Возможные HTTP коды ответа
Интерфейс #9: Детальная информация по смене
URL: https://*****.taxicrm.ru/api/public/v1/shifts/stat/get
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в shift
Возможные HTTP коды ответа
Интерфейс #10: Изменение лимитов для пользователя
URL: URL: https://*****.taxicrm.ru/api/public/v1/ user/limits/change
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #11: Получение списка чатов
URL: https://*****.taxicrm.ru/api/public/v1/chats/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в chats_list
Возможные HTTP коды ответа
Интерфейс #12: Получение списка сообщений чата
URL: https://*****.taxicrm.ru/api/public/v1/chats/messages/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в data
Возможные HTTP коды ответа
Интерфейс #13: Создание нового сообщения
URL: https://*****.taxicrm.ru/api/public/v1/chats/messages/create
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #14: Список автомобилей
URL: https://*****.taxicrm.ru/api/public/v1/cars/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #15: Получение способов и периодичностей выплат
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/settings/get
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в methods
Параметры, возвращаемые в periods
Параметры, возвращаемые в periods
Интерфейс #16: Список ролей
URL: https://*****.taxicrm.ru/api/public/v1/user/roles/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в roles_list
Возможные HTTP коды ответа
Интерфейс #17: Изменение пользователя
URL: https://*****.taxicrm.ru/api/public/v1/user/edit
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/settings/change
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/requisites/list
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/requisites/add
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/requisites/remove
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/requisites/change
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #23: Список штрафов
URL: https://*****.taxicrm.ru/api/public/v1/penalty/list
Метод: POST
Параметры запроса
Параметры ответа
Параметры, возвращаемые в penalties_list
Возможные HTTP коды ответа
Интерфейс #24: Профиль штрафа
URL: https://*****.taxicrm.ru/api/public/v1/penalty/get
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Интерфейс #25: Произвольная выплата для пользователя

ДОСТУП К ЭТОМУ ИНТЕРФЕЙСУ МОЖНО ПОЛУЧИТЬ ТОЛЬКО ПО ЗАПРОСУ ЧЕРЕЗ ПОДДЕРЖКУ taxiCRM!
URL: https://*****.taxicrm.ru/api/public/v1/user/payout/create
Метод: POST
Параметры запроса
Параметр ответа
Возможные HTTP коды ответа
Интерфейс #26: Изменение баланса пользователя

ДОСТУП К ЭТОМУ ИНТЕРФЕЙСУ МОЖНО ПОЛУЧИТЬ ТОЛЬКО ПО ЗАПРОСУ ЧЕРЕЗ ПОДДЕРЖКУ taxiCRM!
URL: https://*****. taxicrm.ru/api/public/v1/user/balance/change
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа
Дополнение:

ID кабинета и ID пользователя внутри кабинета можно получить в интерфейсе списка пользователей. Данные о кабинетах хранятся в поле balance->cabinets и представляют собой ассоциативный массив, где ключ – название агрегатора, значение - массив с данными по кабинету, где ключ – ID кабинета, значение – массив, где ключ - ID пользователя в кабинете, значение – баланс пользователя кабинета внутри кабинета.

URL: https://*****. taxicrm.ru/api/public/v1/user/transaction/types/list
Метод: POST
Параметры запроса
Параметры ответа
Возможные HTTP коды ответа