Для общего описания протокола перейдите на страницу: Описание протокола API...
$ curl -X GET -G http://scat-server/api/version
{"status": "DONE", "response": {"version": "1.10.0"}}
| URL |
/api/version |
| Метод запроса |
GET |
| Требуется ключ |
Нет |
{
"version": str // информация о версии (1.0.0)
}
$ curl -X GET -G http://scat-server/api/changeset
{"status": "DONE", "changeset": [["1.0.0", "Базовый набор функций"]]}
| URL |
/api/changeset |
| Метод запроса |
GET |
| Требуется ключ |
Нет |
{
"changeset": [
["version", "changes"],
...
] // список изменений (1.10.0)
}
| Версия |
Описание |
| 1.0.0 |
Базовый набор функций |
| 1.0.1 |
При получении списка улиц istartswith заменён на icontains |
| 1.1.0 |
Получаем список служб и тарифов |
| 1.1.1 |
Расширенная информация в списке тарифов |
| 1.2.0 |
Получаем список водителей |
| 1.3.0 |
Получаем координаты водителя по его позывному |
| 1.3.1 |
Возвращаем номер заказа при создании |
| 1.4.0 |
Получаем информацию о заказе |
| 1.4.1 |
Изменён формат ответа о координатах водителя |
| 1.4.2 |
Поле с номером заказа при создании переименовано с id на order_id |
| 1.4.3 |
Поле с номером заказа при создании заменено на uuid |
| 1.4.4 |
Добавлен необязательный параметр time при создании заказа |
| 1.4.5 |
Добавлен необязательный параметр driver_id при создании заказа |
| 1.4.6 |
Добавлен необязательный параметр pre_order_time при создании заказа |
| 1.4.7 |
Добавлены необязательные параметры lat, lon, region_id, amount при создании заказа |
| 1.5.0 |
Получаем стоянку по адресу |
| 1.5.1 |
Добавлен необязательный параметр moderation_required при создании заказа |
| 1.6.0 |
Получаем стоянку по координатам |
| 1.7.0 |
Получаем список стоянок |
| 1.7.1 |
Параметры dst, comment, appartment становятся необязательными при создании заказа |
| 1.7.2 |
Добавлены поля start_time, remaining_time, amount и rate_id в информацию о заказе |
| 1.8.0 |
Отменяем заказ |
| 1.8.1 |
В driver_id теперь возвращается позывной при получении информации о заказе |
| 1.8.2 |
Поля car_brand, car_color, car_model и car_number в информации о заказе |
| 1.8.3 |
Поле phone в списке водителей |
| 1.9.0 |
Отправка СМС |
| 1.9.1 |
Поля firstname и phone в информации о заказе |
| 1.9.2 |
Добавлен необязательный параметр need_notify при создании заказа |
| 1.9.3 |
Добавлены необязательные параметры dst_street и dst_house при создании заказа |
| 1.10.0 |
Получаем список изменений |
| 1.11.0 |
Получение и изменение баланса водителей и контрагентов |
| 1.11.1 |
Исправлено падение при создании заказа с ошибочным region_id |
| 1.11.2 |
Пустая строка с этой версии считается отсутствием аргумента и не передаётся в API функцию |
| 1.12.0 |
Функция для предварительного расчёта стоимости (по тарифной сетке) |
| 1.12.1 |
Для предварительного расчёта идентификатор службы теперь не обязателен (по-умолчанию первая служба) |
| 1.12.2 |
Исправлена работа с пустыми переданными аргументами |
| 1.13.0 |
При создании заказа, расчёте стоимости и в функциях определения стоянки учитывается город |
| 1.13.1 |
Добавлены необязательные параметры city_id, service_id при запросе списка водителей, стоянок |
| 1.13.2 |
При запросе списка служб можно указать city_id, иначе будут возвращены службы для всех городов |
| 1.14.0 |
Добавлен необязательный параметр city_id для списка улиц, изменён алгоритм поиска по паттерну |
| 1.15.0 |
Добавлен необязательный параметр city_id для списка тарифов |
| 1.16.0 |
Расширена информация по водителю (скорость, направление, номер заказа, стоянка) |
| 1.16.1 |
Не используем RPC при получении информации по отдельному водителю |
| 1.17.0 |
Дом указывать не обязательно, если вместо улицы передано название общественного места |
| 1.17.1 |
При создании заказа проверяется наличие номера телефона в чёрном списке |
| 1.18.0 |
Добавлена функция для получения и смены статуса внешнего заказа |
| 1.18.1 |
Добавлен необязательный параметр check для проверки статуса заказа в базе после изменения |
| 1.19.0 |
Расширена информация по водителю (город) |
⚠️ Функция предварительного расчёта вернёт token,
который может быть использован для быстрого создания заказа с уже рассчитанными параметрами:
$ curl -X GET -G http://scat-server/api/order/pre_cost
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d way_points=[{"name": "Нова Парк"}, {"name": "Аэропорт"}]
{"status": "DONE", "response": {"token": "0LfQvdCw0YfQtdC90LjQtSDRgtC+0LrQtdC90LA="}}
$ curl -X POST http://scat-server/api/order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d token=0LfQvdCw0YfQtdC90LjQtSDRgtC+0LrQtdC90LA=
{"status": "DONE", "response": {"uuid": "fc1d6f52-9aef-11e3-84ae-0015af9e1aa1"}}
| URL |
/api/order |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| token |
Токен |
Токен полученный при выполнении предварительного расчёта |
- |
СКАТ 7.0 |
| Необязательные параметры |
| comment |
Комментарий к заказу |
Любой текст |
- |
1.7.1 |
| moderation_required |
Отправлять диспетчеру на модерацию |
yes, no |
yes |
1.5.1 |
| need_notify |
Требуется оповещение клиента |
yes, no |
yes |
1.9.2 |
| driver_id |
Идентификатор водителя |
Натуральное число.
Отправить заказ напрямую водителю.
|
- |
1.0.0 |
| service_id |
Идентификатор службы |
Натуральное число |
1 |
1.0.0 |
| extras |
Доп услуги |
Строка, разделенные запятыми доп. услуги вида extra_id*count или extra_id если кол-во=1 |
- |
1.26.0 |
Массив объектов содержащих поля: street (улица), house (дом), lat(широта), lon(долгота). Все элементы кроме street не обязательны
Например
[{"street": "Пулковская", "house": "78", "lat": 54.454554, "lon": 45.0990999}, {"street": "ТЦ Флагман", "lat": 45.56787, "lon": 45.39807}]
{
"id": int, // идентификатор заказа (1.0.0)
"order_id": int, // идентификатор заказа (1.4.2)
"uuid": uuid, // внешний идентификатор заказа (1.4.3)
"message": str // комментарий системы (1.0.0)
}
$ curl -X GET -G http://scat-server/api/order/pre_cost \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d way_points=[{"name": "Нова Парк"}, {"name": "Аэропорт"}]
{"status": "DONE", "response": {"amount": "638.73"}}
⚠️ Функция предварительного расчёта вернёт token,
который может быть использован для быстрого создания заказа с уже рассчитанными параметрами:
$ curl -X GET -G http://scat-server/api/order/pre_cost
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d way_points=[{"name": "Нова Парк"}, {"name": "Аэропорт"}]
{"status": "DONE", "response": {"token": "0LfQvdCw0YfQtdC90LjQtSDRgtC+0LrQtdC90LA="}}
$ curl -X POST http://scat-server/api/order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d token=0LfQvdCw0YfQtdC90LjQtSDRgtC+0LrQtdC90LA=
{"status": "DONE", "response": {"uuid": "fc1d6f52-9aef-11e3-84ae-0015af9e1aa1"}}
| URL |
/api/order/pre_cost |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| phone |
Телефон |
Номер телефона в международном формате: + <code> <prefix> <number> (E.164)
|
- |
СКАТ 7.0 |
| way_points |
Список адресов |
[
{
// Откуда едем:
"name": "Нова Парк", // Место
"street": "10 Лет Октября", // Улица
"house": "80Ак1", // Дом
"latitude": 56.86804 // Широта (СКАТ >= 8.0)
"longitude": 53.27337, // Долгота (СКАТ >= 8.0)
"lat": 56.86804, // Широта (СКАТ < 8.0)
"lon": 53.27337, // Долгота (СКАТ < 8.0)
"entrance": "Центральный вход", // Подъезд
"floor": "3", // Этаж
"apartment": "309б", // Квартира/Офис
"region_id": 1 // Идентификатор района
},
{
// Куда едем сначала
},
{
// Куда едем потом
}
]
|
- |
СКАТ 7.0 |
| service_id |
Идентификатор службы |
Натуральное число. |
1 |
1.12.1 |
| pre_order_time_utc |
Время предварительного заказа (UTC) |
yyyy-mm-dd HH:MM:SS
Время предварительного заказа в часовом поясе UTC.
|
- |
СКАТ 7.0 |
| extras |
Дополнительные услуги |
⚠️ Дополнительные услуги с флагом "по-умолчанию" должны быть переданы явно.
{
// "id": count
"76": 1, // кондиционер
"12": 2 // два детских кресла
}
|
- |
СКАТ 7.0 |
| use_bonuses |
Использовать бонусы |
yes/no
Количество используемых бонусов определяется автоматически согласно условиям бонусной программы.
|
- |
СКАТ 7.0 |
| src_name |
Место |
Название места для исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_street |
Улица |
Название улицы для исходной точки включая префикс.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_house |
Дом |
Номер дома для исходной точки включая корпус и литеру.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_lat |
Широта |
Широта исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_lon |
Долгота |
Долгота исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_entrance |
Подъезд |
Номер подъезда или уточнение места подачи автомобиля для исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_floor |
Этаж |
Этаж для исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_apartment |
Квартира/Офис |
Номер квартиры/офиса для исходной точки.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| src_region_id |
Район |
Идентификатор района исходной точки.
Натуральное число.
Будет добавлено в начало списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_name |
Место |
Название места для точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_street |
Улица |
Название улицы для точки назначения включая префикс.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_house |
Дом |
Номер дома для точки назначения включая корпус и литеру.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_lat |
Широта |
Широта точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_lon |
Долгота |
Долгота точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_entrance |
Подъезд |
Номер подъезда или уточнение места подачи автомобиля для точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_floor |
Этаж |
Этаж для точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_apartment |
Квартира/Офис |
Номер квартиры/офиса для точки назначения.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| dst_region_id |
Район |
Идентификатор района точки назначения.
Натуральное число.
Будет добавлено в конец списка адресов.
⚠️ В СКАТ 8.0 настоятельно рекомендуем вместо этого параметра использовать way_points.
|
- |
СКАТ 7.0 |
| route_time |
Время в пути |
Время в секундах рассчитанное внешним сервисом.
Натуральное число.
|
- |
1.50.1 |
| distance |
Дистанция |
Дистанция в метрах рассчитанная внешним сервисом.
Натуральное число.
|
- |
1.50.1 |
| queue_id |
Идентификатор очереди |
Натуральное число. |
Основная очередь выбранной службы |
1.12.1 |
| rate_id |
Идентификатор тарифа |
Натуральное число. |
Основной тариф выбранной службы |
1.12.1 |
| customer_id |
Идентификатор контрагента |
Натуральное число. |
- |
1.12.1 |
| customer_card_id |
Идентификатор карты контрагента |
Натуральное число. |
- |
1.12.1 |
| customer_card_number |
Номер карты контрагента |
Натуральное число. |
- |
1.12.1 |
{
"amount": string // стоимость заказа (1.12.0)
"distance": float // дистанция маршрута
"approximate": boolean // примерная стоимость - true. false - точная стоимость
"token": string // код гарантированной стоимости. используется для создания заказа
"route": { // детализация маршрута
"distance": float, // дистанция маршрута
"points": [[latitude: float, longitude: float], ...] // точки маршрута
},
"rateMutatedByLoad": boolean // тариф был изменён из-за повышенного спроса
"loadMarkup": string // наценка в валюте из-за повышенного спроса
"loadMarkupPercent": string // наценка в процентах из-за повышенного спроса
}
$ curl -X GET -G http://scat-server/api/order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"status": 100, "message": "Заказ выполнен", "driver_id": "d1", "start_time": "2014-08-26 18:15:00", "remaining_time": "5", "amount": 150.00, "rate_id": 1}}
| URL |
/api/order |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.4.0 |
{
status: int, // код статуса заказа (1.4.0)
message: str, // сообщение статуса заказа (1.4.0)
driver_id: str // идентификатор водителя (1.4.0)
driver_id: str // позывной (1.8.1)
start_time: datetime/null, // время начала выполнения заказа (%Y-%m-%d %H:%M:%S) (1.7.2)
remaining_time: int/null, // время подачи автомобиля (в минутах) (1.7.2)
amount: float/null, // стоимость заказа (1.7.2)
rate_id: int/null, // идентификатор тарифа (1.7.2)
car_brand: str, // марка (1.8.2)
car_model: str, // модель (1.8.2)
car_color: str, // цвет (1.8.2)
car_number: str // госномер (1.8.2)
}
$ curl -X POST http://scat-server/api/cancel_order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"message": "Your order canceled."}}
| URL |
/api/cancel_order |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.8.0 |
{
message: str, // комментарий системы (1.8.0)
}
$ curl -X POST http://scat-server/api/order/status \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1 \
-d code=7
{"status": "DONE", "response": {"code": 7, "name": "Клиент не выходит"}}
| URL |
/api/order/status |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.18.0 |
| code |
Код статуса заказа |
Натуральное число |
- |
1.18.0 |
| Необязательные параметры |
| check |
Проверить изменение статуса в базе перед ответом (медленно) |
yes, no |
no |
1.18.1 |
{
code: int, // код статуса заказа (1.18.0)
name: str // наименование статуса (1.18.0)
}
$ curl -X GET -G http://scat-server/api/order/status \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"code": 7, "name": "Клиент не выходит"}}
| URL |
/api/order/status |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.18.0 |
{
code: int, // код статуса заказа (1.18.0)
name: str // наименование статуса (1.18.0)
}
$ curl -X GET -G http://scat-server/api/services \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"services": [{"id": 1, "name": "Такси", "city_id": 1}, {"id": 2, "name": "Тест", "city_id": 1}]}}
| URL |
/api/services |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.13.2 |
{
"services":
[
{
"id": int, // идентификатор службы (1.1.0)
"name": str, // наименование службы (1.1.0)
"city_id": int // идентификатор города, если не указан в запросе (1.13.2)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/regions \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"regions": [{"id": 1, "name": "Центр"}, {"id": 2, "name": "Металлург"}]}}
| URL |
/api/services |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Нтуральное число |
- |
1.13.1 |
| city_id |
Идентификатор города |
Нтуральное число |
- |
1.13.1 |
{
"regions":
[
{
"id": int, // идентификатор стоянки (1.7.0)
"name": str // наименование стоянки (1.7.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/region_by_address \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d street=Пушкинская \
-d house=268
{"status": "DONE", "response": {"id": 1, "name": "Центр"}}
| URL |
/api/region_by_address |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| street |
Название улицы |
Название улицы, включая префикс |
- |
1.5.0 |
| house |
Номер дома клиента |
Номер дома, включая корпус и литеру |
- |
1.5.0 |
{
"id": int, // идентификатор стоянки (1.5.0)
"name": str // наименование стоянки (1.5.0)
}
$ curl -X GET -G http://scat-server/api/region_by_coord \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d lon=12.345678 \
-d lat=87.654321
{"status": "DONE", "response": {"id": 1, "name": "Центр"}}
| URL |
/api/region_by_coord |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| lon |
Координаты клиента: долгота |
Число с плавающей точкой |
- |
1.6.0 |
| lat |
Координаты клиента: широта |
Число с плавающей точкой |
- |
1.6.0 |
{
"id": int, // идентификатор стоянки (1.6.0)
"name": str // наименование стоянки (1.6.0)
}
$ curl -X GET -G http://scat-server/api/rates \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"rates": [{"id": 1, "name": "Эконом", "km_cost": "15.00", "km_start": 2, "stand_kost": "10.00", "free_wait_time": 5, "free_stand_time": 1, "start_hour": 18, "end_hour": 22, "city_id": 1}, {"id": 2, "name": "ВИП", "km_cost": "20.00", "km_start": 1, "stand_kost": "15.00", "free_wait_time": 10, "free_stand_time": 2, "start_hour": null, "end_hour": null, "city_id": 1}]}}
| URL |
/api/rates |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.15.0 |
{
rates:
[
{
id: int, // идентификатор (1.1.0)
name: str, // наименование (1.1.0)
km_cost: float, // стоимость километра (1.1.1)
km_start: int, // сколько первых километров не считается (1.1.1)
stand_cost: float, // стоимость стоянки (1.1.1)
free_wait_time: int, // время бесплатного ожидания (1.1.1)
free_stand_time: int, // сколько первых минут стоянки не считаются (1.1.1)
start_hour: int/null, // время начала действия тарифа (1.1.1)
end_hour: int/null, // время окончания действия тарифа (1.1.1)
city_id: int // идентификатор города, если не указан в запросе (1.15.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/streets \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d pattern=киров
{"status": "DONE", "response": {"streets": ["Кирова", "Парк им. Кирова"]}}
| URL |
/api/streets |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| pattern |
Начало имени для поиска |
Любая строка |
- |
1.0.0 |
| pattern |
Часть имени для поиска |
Любая строка |
- |
1.0.1 |
| pattern |
Начало любого слова в наименовании для поиска без учёта регистра |
Любая строка |
- |
1.14.0 |
| Необязательные параметры |
| city_id |
Идентификатор города |
Любая строка |
- |
1.14.0 |
{
"streets":
[
str, // название улицы/общественного места (1.0.0)
// ...
]
}
$ curl -X GET -G http://scat-server/api/drivers \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"drivers": [{"first_name": "Иван", "code": "001", "car_brand": "Ниссан", "car_model": "Альмера", "car_reg_num": "A476BO", "lon": "12.345678", "lat": "87.654321", "permit_number": "58567437900", "car_year": "1997", "phone": "89123456789", "id": 1}]}}
| URL |
/api/drivers |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Натуральное число |
- |
1.13.1 |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.13.1 |
{
"drivers":
[
{
id: int, // идентификатор водителя (1.2.0)
first_name: str, // имя (1.2.0)
code: str, // позывной (1.2.0)
phone: str, // номер телефона (1.8.3)
permit_number: str/null, // номер разрешения (1.2.0)
lat: str, // широта (1.2.0)
lon: str, // долгота (1.2.0)
car_brand: str, // марка авто (1.2.0)
car_model: str, // модель (1.2.0)
car_reg_num: str, // гос.номер (1.2.0)
car_year: str/null // год выпуска (1.2.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/drivers \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d code=001
{"status": "DONE", "response": {"bearing": 0, "region_id": 45, "city_id": 1, "lon": 53.273845, "order_id": null, "lat": 56.86814, "speed": 0}}
| URL |
/api/drivers |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| code |
Позывной водителя |
Любая строка |
- |
1.3.0 |
{
driver = {
lat: str,
lon: str
} // координаты (1.3.0)
lat: str, // широта (1.4.1)
lon: str, // долгота (1.4.1)
lat: float, // широта (1.16.0)
lon: float, // долгота (1.16.0)
speed: float, // скорость (1.16.0)
bearing: float, // направление (1.16.0)
order_id: int/null, // идентификатор заказа (1.16.0)
region_id: int/null, // идентификатор стоянки (1.16.0)
city_id: int // идентификатор города (1.19.0)
}
$ curl -X GET -G http://scat-server/api/client/bonus/count \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d phone=89012345678
{"status": "DONE", "response": {"bonus": 100, "phone": "89012345678"}}
| URL |
/api/client/bonus/count |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| phone |
Номер телефона клиента |
Номер телефона, начинающийся с 8... |
- |
1.0.0 |
{
"phone": str, // номер телефона клиента (1.0.0)
"bonus": int // количество бонусов (1.0.0)
}
$ curl -X POST http://scat-server/api/driver/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001 \
-d txn_id=f782t32t23328r3r223r23t5y6h54r \
-d amount=500
{"status": "DONE", "response": {"balance": 1100.0}}
| URL |
/api/driver/balance |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| driver_code |
Позывной водителя |
Строка |
- |
1.11.0 |
| txn_id |
Номер транзакции |
Строка (>=30) |
- |
1.11.0 |
| amount |
Сумма платежа |
Число с плавающей точкой |
- |
1.11.0 |
{
"balance": float // баланс водителя после платежа (1.11.0)
}
$ curl -X GET -G http://scat-server/api/driver/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001
{"status": "DONE", "response": {"balance": 1100.0, "firstname": "Иванов", "lastname": "Иван", "middlename": "Иванович"}}
| URL |
/api/driver/balance |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| driver_code |
Позывной водителя |
Строка |
- |
1.11.0 |
{
"balance": float, // баланс водителя (1.11.0)
"firstname": str, // имя водителя (1.11.0)
"lastname": str, // фамилия водителя (1.11.0)
"middlename": str // отчество водителя (1.11.0)
}
$ curl -X POST http://scat-server/api/customer/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d customer_id=1 \
-d amount=500
{"status": "DONE", "response": {"balance": 1100.0}}
Для общего описания протокола перейдите на страницу: Описание протокола API...
$ curl -X GET -G http://scat-server/api/version
{"status": "DONE", "response": {"version": "1.10.0"}}
| URL |
/api/customer/balance |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| URL |
/api/version |
| Метод запроса |
GET |
| Требуется ключ |
Нет |
{
"version": str // информация о версии (1.0.0)
}
$ curl -X GET -G http://scat-server/api/changeset
{"status": "DONE", "changeset": [["1.0.0", "Базовый набор функций"]]}
| URL |
/api/changeset |
| Метод запроса |
GET |
| Требуется ключ |
Нет |
{
"changeset": [
["version", "changes"],
...
] // список изменений (1.10.0)
}
| Версия |
Описание |
| 1.0.0 |
Базовый набор функций |
| 1.0.1 |
При получении списка улиц istartswith заменён на icontains |
| 1.1.0 |
Получаем список служб и тарифов |
| 1.1.1 |
Расширенная информация в списке тарифов |
| 1.2.0 |
Получаем список водителей |
| 1.3.0 |
Получаем координаты водителя по его позывному |
| 1.3.1 |
Возвращаем номер заказа при создании |
| 1.4.0 |
Получаем информацию о заказе |
| 1.4.1 |
Изменён формат ответа о координатах водителя |
| 1.4.2 |
Поле с номером заказа при создании переименовано с id на order_id |
| 1.4.3 |
Поле с номером заказа при создании заменено на uuid |
| 1.4.4 |
Добавлен необязательный параметр time при создании заказа |
| 1.4.5 |
Добавлен необязательный параметр driver_id при создании заказа |
| 1.4.6 |
Добавлен необязательный параметр pre_order_time при создании заказа |
| 1.4.7 |
Добавлены необязательные параметры lat, lon, region_id, amount при создании заказа |
| 1.5.0 |
Получаем стоянку по адресу |
| 1.5.1 |
Добавлен необязательный параметр moderation_required при создании заказа |
| 1.6.0 |
Получаем стоянку по координатам |
| 1.7.0 |
Получаем список стоянок |
| 1.7.1 |
Параметры dst, comment, appartment становятся необязательными при создании заказа |
| 1.7.2 |
Добавлены поля start_time, remaining_time, amount и rate_id в информацию о заказе |
| 1.8.0 |
Отменяем заказ |
| 1.8.1 |
В driver_id теперь возвращается позывной при получении информации о заказе |
| 1.8.2 |
Поля car_brand, car_color, car_model и car_number в информации о заказе |
| 1.8.3 |
Поле phone в списке водителей |
| 1.9.0 |
Отправка СМС |
| 1.9.1 |
Поля firstname и phone в информации о заказе |
| 1.9.2 |
Добавлен необязательный параметр need_notify при создании заказа |
| 1.9.3 |
Добавлены необязательные параметры dst_street и dst_house при создании заказа |
| 1.10.0 |
Получаем список изменений |
| 1.11.0 |
Получение и изменение баланса водителей и контрагентов |
| 1.11.1 |
Исправлено падение при создании заказа с ошибочным region_id |
| 1.11.2 |
Пустая строка с этой версии считается отсутствием аргумента и не передаётся в API функцию |
| 1.12.0 |
Функция для предварительного расчёта стоимости (по тарифной сетке) |
| 1.12.1 |
Для предварительного расчёта идентификатор службы теперь не обязателен (по-умолчанию первая служба) |
| 1.12.2 |
Исправлена работа с пустыми переданными аргументами |
| 1.13.0 |
При создании заказа, расчёте стоимости и в функциях определения стоянки учитывается город |
| 1.13.1 |
Добавлены необязательные параметры city_id, service_id при запросе списка водителей, стоянок |
| 1.13.2 |
При запросе списка служб можно указать city_id, иначе будут возвращены службы для всех городов |
| 1.14.0 |
Добавлен необязательный параметр city_id для списка улиц, изменён алгоритм поиска по паттерну |
| 1.15.0 |
Добавлен необязательный параметр city_id для списка тарифов |
| 1.16.0 |
Расширена информация по водителю (скорость, направление, номер заказа, стоянка) |
| 1.16.1 |
Не используем RPC при получении информации по отдельному водителю |
| 1.17.0 |
Дом указывать не обязательно, если вместо улицы передано название общественного места |
| 1.17.1 |
При создании заказа проверяется наличие номера телефона в чёрном списке |
| 1.18.0 |
Добавлена функция для получения и смены статуса внешнего заказа |
| 1.18.1 |
Добавлен необязательный параметр check для проверки статуса заказа в базе после изменения |
| 1.19.0 |
Расширена информация по водителю (город) |
$ curl -X POST http://scat-server/api/order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d phone=89012345678 \
-d street=Ленина \
-d house=11а \
-d appartment=42 \
-d dst="Пушкинская 268" \
-d moderation_required=no
{"status": "DONE", "response": {"message": "Your order saved.", "uuid": "fc1d6f52-9aef-11e3-84ae-0015af9e1aa1"}}
| URL |
/api/order |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| phone |
Номер телефона клиента |
Номер телефона, начинающийся с 8... |
- |
1.0.0 |
| street |
Название улицы/общественного места |
Название улицы/общественного места, включая префикс |
- |
1.17.0 |
| street |
Название улицы |
Название улицы, включая префикс |
- |
1.0.0 |
| house |
Номер дома клиента |
Номер дома, включая корпус и литеру |
- |
1.0.0 |
| appartment |
Номер квартиры клиента |
Число |
- |
1.0.0 |
| dst |
Точка назначения |
Адрес точки назначения в одну строку |
- |
1.0.0 |
| comment |
Комментарий к заказу |
Любой текст |
- |
1.0.0 |
| Необязательные параметры |
| house |
Номер дома клиента |
Номер дома, включая корпус и литеру |
- |
1.17.0 |
| appartment |
Номер квартиры клиента |
Число |
- |
1.7.1 |
| dst |
Точка назначения |
Адрес точки назначения в одну строку |
- |
1.7.1 |
| region_id |
Идентификатор стоянки |
Натуральное число |
- |
1.4.7 |
| lon |
Координаты клиента: долгота |
Число с плавающей точкой |
- |
1.4.7 |
| lat |
Координаты клиента: широта |
Число с плавающей точкой |
- |
1.4.7 |
| moderation_required |
Отправлять диспетчеру на модерацию |
yes, no |
yes |
1.5.1 |
| service_id |
Идентификатор службы |
Натуральное число |
1 |
1.0.0 |
| driver_id |
Идентификатор водителя |
Натуральное число |
- |
1.0.0 |
| amount |
Стоимость заказа |
Число с плавающей точкой |
- |
1.4.7 |
| pre_order_time |
Время предварительного заказа |
Время и дата в формате %Y-%m-%d %H:%M:%S |
- |
1.4.6 |
| comment |
Комментарий к заказу |
Любой текст |
- |
1.7.1 |
| need_notify |
Требуется оповещение клиента |
yes, no |
yes |
1.9.2 |
| dst_street |
Улица назначения |
Название улицы, включая префикс |
- |
1.9.3 |
| dst_house |
Дом назначения |
Номер дома, включая корпус и литеру |
- |
1.9.3 |
| dst_lat |
Координата адреса назначения: широта |
Число с плавающей точкой |
- |
1.26.0 |
| dst_lon |
Координата адреса назначения: долгота |
Число с плавающей точкой |
- |
1.26.0 |
| way_points |
Промежуточные точки маршрута |
JSONArray |
- |
1.26.0 |
| extras |
Доп услуги |
Строка, разделенные запятыми доп. услуги вида extra_id*count или extra_id если кол-во=1 |
- |
1.26.0 |
Массив объектов содержащих поля: street (улица), house (дом), lat(широта), lon(долгота). Все элементы кроме street не обязательны
Например
[{"street": "Пулковская", "house": "78", "lat": 54.454554, "lon": 45.0990999}, {"street": "ТЦ Флагман", "lat": 45.56787, "lon": 45.39807}]
{
"id": int, // идентификатор заказа (1.0.0)
"order_id": int, // идентификатор заказа (1.4.2)
"uuid": uuid, // внешний идентификатор заказа (1.4.3)
"message": str // комментарий системы (1.0.0)
}
$ curl -X GET -G http://scat-server/api/order/pre_cost \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d src_street=Ленина \
-d src_house=11а \
-d dst_street=Кирова \
-d dst_house=18
{"status": "DONE", "response": {"amount": 100.0}}
| URL |
/api/order/pre_cost |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| src_street |
Название улицы |
Название улицы, включая префикс |
- |
1.12.0 |
| src_house |
Номер дома клиента |
Номер дома, включая корпус и литеру |
- |
1.12.0 |
| dst_street |
Улица назначения |
Название улицы, включая префикс |
- |
1.12.0 |
| dst_house |
Дом назначения |
Номер дома, включая корпус и литеру |
- |
1.12.0 |
| service_id |
Идентификатор службы |
Натуральное число |
- |
1.12.0 |
| Необязательные параметры |
| src_lon |
Координаты клиента: долгота |
Число с плавающей точкой |
- |
1.12.0 |
| src_lat |
Координаты клиента: широта |
Число с плавающей точкой |
- |
1.12.0 |
| dst_lon |
Координаты точки назначения: долгота |
Число с плавающей точкой |
- |
1.12.0 |
| dst_lat |
Координаты точки назначения: широта |
Число с плавающей точкой |
- |
1.12.0 |
| src_region_id |
Идентификатор района клиента |
Натуральное число |
- |
1.12.0 |
| dst_region_id |
Идентификатор района назначения |
Натуральное число |
- |
1.12.0 |
| service_id |
Идентификатор службы |
Натуральное число |
1 |
1.12.1 |
| route_time |
Время в пути, в секундах |
Натуральное число |
- |
1.50.1 |
{
"amount": string // стоимость заказа (1.12.0)
"distance": float // дистанция маршрута
"approximate": boolean // примерная стоимость - true. false - точная стоимость
"token": string // код гарантированной стоимости. используется для создания заказа
}
$ curl -X GET -G http://scat-server/api/order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"status": 100, "message": "Заказ выполнен", "driver_id": "d1", "start_time": "2014-08-26 18:15:00", "remaining_time": "5", "amount": 150.00, "rate_id": 1}}
| URL |
/api/order |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.4.0 |
{
status: int, // код статуса заказа (1.4.0)
message: str, // сообщение статуса заказа (1.4.0)
driver_id: str // идентификатор водителя (1.4.0)
driver_id: str // позывной (1.8.1)
start_time: datetime/null, // время начала выполнения заказа (%Y-%m-%d %H:%M:%S) (1.7.2)
remaining_time: int/null, // время подачи автомобиля (в минутах) (1.7.2)
amount: float/null, // стоимость заказа (1.7.2)
rate_id: int/null, // идентификатор тарифа (1.7.2)
car_brand: str, // марка (1.8.2)
car_model: str, // модель (1.8.2)
car_color: str, // цвет (1.8.2)
car_number: str // госномер (1.8.2)
}
$ curl -X POST http://scat-server/api/cancel_order \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"message": "Your order canceled."}}
| URL |
/api/cancel_order |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.8.0 |
{
message: str, // комментарий системы (1.8.0)
}
$ curl -X POST http://scat-server/api/order/status \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1 \
-d code=7
{"status": "DONE", "response": {"code": 7, "name": "Клиент не выходит"}}
| URL |
/api/order/status |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.18.0 |
| code |
Код статуса заказа |
Натуральное число |
- |
1.18.0 |
| Необязательные параметры |
| check |
Проверить изменение статуса в базе перед ответом (медленно) |
yes, no |
no |
1.18.1 |
{
code: int, // код статуса заказа (1.18.0)
name: str // наименование статуса (1.18.0)
}
$ curl -X GET -G http://scat-server/api/order/status \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d uuid=fc1d6f52-9aef-11e3-84ae-0015af9e1aa1
{"status": "DONE", "response": {"code": 7, "name": "Клиент не выходит"}}
| URL |
/api/order/status |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| uuid |
Уникальный идентификатор заказа, полученный при его создании |
uuid |
- |
1.18.0 |
{
code: int, // код статуса заказа (1.18.0)
name: str // наименование статуса (1.18.0)
}
$ curl -X GET -G http://scat-server/api/services \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"services": [{"id": 1, "name": "Такси", "city_id": 1}, {"id": 2, "name": "Тест", "city_id": 1}]}}
| URL |
/api/services |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.13.2 |
{
"services":
[
{
"id": int, // идентификатор службы (1.1.0)
"name": str, // наименование службы (1.1.0)
"city_id": int // идентификатор города, если не указан в запросе (1.13.2)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/regions \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"regions": [{"id": 1, "name": "Центр"}, {"id": 2, "name": "Металлург"}]}}
| URL |
/api/services |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Нтуральное число |
- |
1.13.1 |
| city_id |
Идентификатор города |
Нтуральное число |
- |
1.13.1 |
{
"regions":
[
{
"id": int, // идентификатор стоянки (1.7.0)
"name": str // наименование стоянки (1.7.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/region_by_address \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d street=Пушкинская \
-d house=268
{"status": "DONE", "response": {"id": 1, "name": "Центр"}}
| URL |
/api/region_by_address |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| street |
Название улицы |
Название улицы, включая префикс |
- |
1.5.0 |
| house |
Номер дома клиента |
Номер дома, включая корпус и литеру |
- |
1.5.0 |
{
"id": int, // идентификатор стоянки (1.5.0)
"name": str // наименование стоянки (1.5.0)
}
$ curl -X GET -G http://scat-server/api/region_by_coord \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d lon=12.345678 \
-d lat=87.654321
{"status": "DONE", "response": {"id": 1, "name": "Центр"}}
| URL |
/api/region_by_coord |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| lon |
Координаты клиента: долгота |
Число с плавающей точкой |
- |
1.6.0 |
| lat |
Координаты клиента: широта |
Число с плавающей точкой |
- |
1.6.0 |
{
"id": int, // идентификатор стоянки (1.6.0)
"name": str // наименование стоянки (1.6.0)
}
$ curl -X GET -G http://scat-server/api/rates \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"rates": [{"id": 1, "name": "Эконом", "km_cost": "15.00", "km_start": 2, "stand_kost": "10.00", "free_wait_time": 5, "free_stand_time": 1, "start_hour": 18, "end_hour": 22, "city_id": 1}, {"id": 2, "name": "ВИП", "km_cost": "20.00", "km_start": 1, "stand_kost": "15.00", "free_wait_time": 10, "free_stand_time": 2, "start_hour": null, "end_hour": null, "city_id": 1}]}}
| URL |
/api/rates |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.15.0 |
{
rates:
[
{
id: int, // идентификатор (1.1.0)
name: str, // наименование (1.1.0)
km_cost: float, // стоимость километра (1.1.1)
km_start: int, // сколько первых километров не считается (1.1.1)
stand_cost: float, // стоимость стоянки (1.1.1)
free_wait_time: int, // время бесплатного ожидания (1.1.1)
free_stand_time: int, // сколько первых минут стоянки не считаются (1.1.1)
start_hour: int/null, // время начала действия тарифа (1.1.1)
end_hour: int/null, // время окончания действия тарифа (1.1.1)
city_id: int // идентификатор города, если не указан в запросе (1.15.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/streets \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d pattern=киров
{"status": "DONE", "response": {"streets": ["Кирова", "Парк им. Кирова"]}}
| URL |
/api/streets |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| pattern |
Начало имени для поиска |
Любая строка |
- |
1.0.0 |
| pattern |
Часть имени для поиска |
Любая строка |
- |
1.0.1 |
| pattern |
Начало любого слова в наименовании для поиска без учёта регистра |
Любая строка |
- |
1.14.0 |
| Необязательные параметры |
| city_id |
Идентификатор города |
Любая строка |
- |
1.14.0 |
{
"streets":
[
str, // название улицы/общественного места (1.0.0)
// ...
]
}
$ curl -X GET -G http://scat-server/api/drivers \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a
{"status": "DONE", "response": {"drivers": [{"first_name": "Иван", "code": "001", "car_brand": "Ниссан", "car_model": "Альмера", "car_reg_num": "A476BO", "lon": "12.345678", "lat": "87.654321", "permit_number": "58567437900", "car_year": "1997", "phone": "89123456789", "id": 1}]}}
| URL |
/api/drivers |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Натуральное число |
- |
1.13.1 |
| city_id |
Идентификатор города |
Натуральное число |
- |
1.13.1 |
{
"drivers":
[
{
id: int, // идентификатор водителя (1.2.0)
first_name: str, // имя (1.2.0)
code: str, // позывной (1.2.0)
phone: str, // номер телефона (1.8.3)
permit_number: str/null, // номер разрешения (1.2.0)
lat: str, // широта (1.2.0)
lon: str, // долгота (1.2.0)
car_brand: str, // марка авто (1.2.0)
car_model: str, // модель (1.2.0)
car_reg_num: str, // гос.номер (1.2.0)
car_year: str/null // год выпуска (1.2.0)
},
// ...
]
}
$ curl -X GET -G http://scat-server/api/drivers \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d code=001
{"status": "DONE", "response": {"bearing": 0, "region_id": 45, "city_id": 1, "lon": 53.273845, "order_id": null, "lat": 56.86814, "speed": 0}}
| URL |
/api/drivers |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| code |
Позывной водителя |
Любая строка |
- |
1.3.0 |
{
driver = {
lat: str,
lon: str
} // координаты (1.3.0)
lat: str, // широта (1.4.1)
lon: str, // долгота (1.4.1)
lat: float, // широта (1.16.0)
lon: float, // долгота (1.16.0)
speed: float, // скорость (1.16.0)
bearing: float, // направление (1.16.0)
order_id: int/null, // идентификатор заказа (1.16.0)
region_id: int/null, // идентификатор стоянки (1.16.0)
city_id: int // идентификатор города (1.19.0)
}
$ curl -X GET -G http://scat-server/api/client/bonus/count \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d phone=89012345678
{"status": "DONE", "response": {"bonus": 100, "phone": "89012345678"}}
| URL |
/api/client/bonus/count |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| phone |
Номер телефона клиента |
Номер телефона, начинающийся с 8... |
- |
1.0.0 |
{
"phone": str, // номер телефона клиента (1.0.0)
"bonus": int // количество бонусов (1.0.0)
}
$ curl -X POST http://scat-server/api/driver/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001 \
-d txn_id=f782t32t23328r3r223r23t5y6h54r \
-d amount=500
{"status": "DONE", "response": {"balance": 1100.0}}
| URL |
/api/driver/balance |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| driver_code |
Позывной водителя |
Строка |
- |
1.11.0 |
| txn_id |
Номер транзакции |
Строка (>=30) |
- |
1.11.0 |
| amount |
Сумма платежа |
Число с плавающей точкой |
- |
1.11.0 |
{
"balance": float // баланс водителя после платежа (1.11.0)
}
$ curl -X GET -G http://scat-server/api/driver/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001
{"status": "DONE", "response": {"balance": 1100.0, "firstname": "Иванов", "lastname": "Иван", "middlename": "Иванович"}}
| URL |
/api/driver/balance |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| driver_code |
Позывной водителя |
Строка |
- |
1.11.0 |
{
"balance": float, // баланс водителя (1.11.0)
"firstname": str, // имя водителя (1.11.0)
"lastname": str, // фамилия водителя (1.11.0)
"middlename": str // отчество водителя (1.11.0)
}
$ curl -X POST http://scat-server/api/customer/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d customer_id=1 \
-d amount=500
{"status": "DONE", "response": {"balance": 1100.0}}
| URL |
/api/customer/balance |
| Метод запроса |
POST |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| customer_id |
Идентификатор контрагента |
Целое число |
- |
1.11.0 |
| amount |
Сумма платежа |
Число с плавающей точкой |
- |
1.11.0 |
{
"balance": float // баланс контрагента после платежа (1.11.0)
}
$ curl -X GET -G http://scat-server/api/customer/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001
{"status": "DONE", "response": {"balance": 1100.0, "name": "Иван"}}
| URL |
/api/customer/balance |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| customer_id |
Идентификатор контрагента |
Целое число |
- |
1.11.0 |
{
"balance": float, // баланс контрагента (1.11.0)
"name": str // имя контрагента (1.11.0)
}
$ curl -X GET -G http://scat-server/api/extras \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d service_id=1
{"status": "DONE", "response": {"extras": [{"id": 1, "name": "Пустой багажник", "price": 100, "allow_multiple": false}, {....}]}}
| URL |
/api/extras |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Целое число |
- |
1.11.0 |
| queue_id |
Идентификатор очереди заказов |
Целое число |
- |
1.11.0 |
{
"extras": JSONArray, // баланс контрагента (1.11.0)
}
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| customer_id |
Идентификатор контрагента |
Целое число |
- |
1.11.0 |
| amount |
Сумма платежа |
Число с плавающей точкой |
- |
1.11.0 |
{
"balance": float // баланс контрагента после платежа (1.11.0)
}
$ curl -X GET -G http://scat-server/api/customer/balance \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d driver_code=001
{"status": "DONE", "response": {"balance": 1100.0, "name": "Иван"}}
| URL |
/api/customer/balance |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Обязательные параметры |
| customer_id |
Идентификатор контрагента |
Целое число |
- |
1.11.0 |
{
"balance": float, // баланс контрагента (1.11.0)
"name": str // имя контрагента (1.11.0)
}
$ curl -X GET -G http://scat-server/api/extras \
-d api_key=0dcf277e-0317-4eef-9142-24b7a2b4788a \
-d service_id=1
{"status": "DONE", "response": {"extras": [{"id": 1, "name": "Пустой багажник", "price": 100, "allow_multiple": false}, {....}]}}
| URL |
/api/extras |
| Метод запроса |
GET |
| Требуется ключ |
Да |
| Параметр |
Описание |
Допустимые значения |
Значение по-умолчанию |
Доступен с версии |
| Необязательные параметры |
| service_id |
Идентификатор службы |
Целое число |
- |
1.11.0 |
| queue_id |
Идентификатор очереди заказов |
Целое число |
- |
1.11.0 |
{
"extras": JSONArray, // баланс контрагента (1.11.0)
}