Все запросы к публичному API taxiCRM выполняются путем передачи JSON с параметрами запроса на адрес интерфейса методом POST.
При обращении к любым интерфейсам данного API в теле запроса всегда должен присутствовать обязательный параметр timestamp, содержащий в себе метку времени, когда запрос к публичному API taxiCRM был создан.
Ответ от API возвращается в JSON, содержащем в себе результат обработки запроса.
Ответ с любым HTTP кодом, отличным от 200 означает ошибку при выполнении запроса.
В случае возникновения ошибок при обработке запроса, текс ошибки будет возвращен в переменной error
Все запросы к публичному API должны быть подписаны с помощью API ключа, который можно найти в настройках taxiCRM (раздел «Компания» > «Настройки компании» > «API»)
Формирование подписи запросов
Подпись запроса необходимо передавать в заголовках запроса в параметре Authorization
phone;string;да;Номер мобильного телефона пользователя в любом формате (валидны варианты: 9111234567 79111234567, +79111234567, 89111234567, +89111234567. Плюс все тоже самое с любым количеством пробелов, скобок, точек, тире и т.п. Таким образом +7 (911) 123-45-67 – тоже валидный номер, который будет корректно обработан)
first_name;string;да;Имя пользователя
last_name;string;да;Фамилия пользователя
middle_name;string;нет;Отчество пользователя
region;int;нет;Код региона пользователя, соответствующий оригинальному коду региона в ГИБДД. Например: 77 – Москва, 78 – Санкт-Петербург, 50 – Московская область, 01 - Республика Адыгея, 23 - Краснодарский край
birthday;string;нет;Дата рождения пользователя. Валидны форматы: 1985-12-31 и 31.12.1985
gender;int;нет;Пол пользователя: 1 – мужской, 2 - женский
email;string;нет;Валидный email адрес пользователя
comment;string;нет;Комментарий к пользователю. Если комментарий передан, то он будет добавлен в качестве комментария к пользователю, который будут виден в его профиле (и логах). Допустим базовый HTML код.
referer_id;string;нет;ID пользователя (реферера), пригласившего регистрируемого пользователя (для учета в партнерской программе)
timestamp;int;да;UNIX время формирования запроса
Параметры ответа
Параметр;Тип;Обязательный;Описание
success;boolean;да;Статус обработки запроса
message;string;нет;Возвращается только если запрос выполнен успешно. Содержит в себе текст с результатом выполнения запроса
error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки
data;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив с некоторыми данными зарегистрированного пользователя
Возможные HTTP коды ответа
HTTP код ответа;Причина
200;Запрос выполнен успешно
400;Не передан обязательный параметр
401;Не передана подпись запроса или подпись неверна
402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен
403;Пользователь с таким номером телефона уже зарегистрирован
415;Ошибка при валидации переданных параметров
500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)
Обратите внимание!
При регистрации пользователя через публичное API не производится валидация его номера телефона и не осуществляется защита от массовых добавлений пользователей роботами! Все это, если это вам необходимо, вы должны организовать самостоятельно на своей стороне.