Руководства разработчика

Описание функций API

Для общего описания протокола перейдите на страницу: Описание протокола API...

Версия 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 Расширена информация по водителю (город)

Создать заказ

$ 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}}

Для общего описания протокола перейдите на страницу: Описание протокола API...

Версия 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)
}