Параметры TM API

Задать настройки для корректной работы TM API вы сможете в ТМ в меню Настройки в одноименной ветке TM API.

1. Установите флажок Использовать TM API.
2. В поле Локальный порт введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах ТМ Сервер. Рекомендуется оставить номер порта по умолчанию.
3. При необходимости установите флажок Использовать автопроброс порта с помощью UPnP, также укажите Внешний порт и Локальный IP.

Ветка "Открытое API"

В данной ветке регулируется доступ к синхронизации ТМ со сторонним сервисом.

1. Установите флажок Использовать открытое API для того, чтобы запустить работу протокола TMCommonAPI.
2. В поле Секретный ключ укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте.
3. В таблице "Пользователи CommonAPI" можно настроить доступ к CommonAPI. Для этого нужно создать пользователей, у которых будет отдельный секретный ключ, и отметить доступные запросы CommonAPI.

Ветка "API для телефонии"

В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие ТМ с call-центром через программный интерфейс.

1. Установите флажок Использовать открытое API для телефонии для того, чтобы запустить работу протокола TMTAPI.
2. В поле Секретный ключ укажите номер секретного ключа для работы.

Ветка "TMK Пассажир API"

В данной ветке находятся параметры, необходимые для взаимосвязи клиентского приложения с программным комплексом ТМ: Корпоративные поездки.

Общее описание протокола

Формат запроса

TMAPI принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (common_api) и версия API. Пример:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1 

Для получения данных из БД используются запросы типа GET. Для записи данных в базу данных используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 
Signature: <...>

В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-urlencoded или application/json в зависимости от запроса. Пример:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в Файл - Настройки - TM API - Открытое API. Пример:

Запрос:
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1

Секретный ключ:
1234567890

Signature = MD5("tariff_id=1&distance_city=10" + "1234567890") = d7b8fb11b5499b64d750b8efe53e2877

Также в запросе может содержаться заголовок "X-User-Id" c ИД пользователя CommonAPI, если запрос делается от какого-то конкретного пользователя CommonAPI. Если будет передан этот заголовок, то секретный ключ будет проверяться именно для указанного пользователя CommonAPI, а также будут проверяться права доступа пользователя CommonAPI к данному запросу. Если заголовок "X-User-Id" не будет передан, то тогда будет проверяться общий секретный ключ CommonAPI, и будет разрешен доступ ко всем запросам CommonAPI. Пример запроса с указанием ИД пользователя:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
X-User-Id: 123
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1

Формат ответа

TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

{
  "code":<Числовой код результата>,
  "descr":"<Строковое описание результата>",
  "data":{<Дополнительная информация>}
}

Существуют общие для всех запросов коды результатов:

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

1. Запрос-пинг

Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1 
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

2. Запрос списка групп экипажей

Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_groups":[
     {
       "id":1,
       "name":"CREW_GROUP1"
     },
     {
       "id":2,
       "name":"CREW_GROUP2"
     }
    ]
  }
}

3. Запрос списка групп клиентов

Метод: GET

Название запроса: get_client_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_client_groups_list HTTP/1.1
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "client_groups":[
      {
        "id":1,
        "name":"CLIENT_GROUP1"
      },
      {
        "id":2,
        "name":"CLIENT_GROUP2"
      }
    ]
  }
}

4. Запрос списка тарифов

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "tariffs":[
      {
        "id":1,
        "name":"TARIFF1"
        "is_active":true 
      },
      {
         "id":2,
         "name":"TARIFF2"
         "is_active":true
      }
    ]
  }
}

5. Запрос списка услуг

Запрос устарел. Рекомендуется использовать запрос списка параметров заказа

Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "services":[
      {
        "id":1,
        "name":"SERVICE1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"SERVICE2"
        "sum":0,
        "percent":10
      }
    ]
  }
}

6. Запрос списка атрибутов

Метод: GET

Название запроса: get_order_params_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_order_params_list HTTP/1.1

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_params":[
      {
        "id":1,
        "name":"PARAM1",
        "sum":100,
        "percent":0,
        "order_access_control":true
      },
      {
        "id":2,
        "name":"PARAM2",
        "sum":0,
        "percent":10,
        "order_access_control":false
      }
    ]
  }
}

7. Запрос списка скидок

Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list  HTTP/1.1 

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "discounts":[
      {
        "id":1,
        "name":"DISCOUNT1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"DISCOUNT2"
        "sum":0,
        "percent":10
      }
    ]
  }
}

8. Создание нового заказа

Метод: POST

Название запроса: create_order

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1&uds_id=1&tariff_id=3&is_prior=false&source_lon=53.147836&
source_lat=56.896817&dest_lon=53.226775&dest_lat=56.845452

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":12345
  }
}

9. Создание нового заказа 2

Метод: POST

Название запроса: create_order2

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_order2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "server_time_offset":2,
  "source_time":"20140415172811",
  "is_prior":false,
  "check_duplicate":true,
  "phone":"123456",
  "phone_to_dial":"654321",
  "client_id":1,  
  "client_employee_id":4,  
  "customer":"CUSTOMER",
  "passenger":"PASSENGER",
  "comment":"COMMENT",
  "crew_group_id":1,
  "uds_id":1,
  "tariff_id":1,
  "addresses": [
      {
          "address": "SOURCE",
          "lat": 56.896817,
          "lon": 53.14783
          "zone_id": 1,
          "parking_id": 1
      },
      {
          "address": "STOP1",
          "lat": 56.845452,
          "lon": 53.226775
          "zone_id": 2,
          "parking_id": 2
      },
      {
          "address": "STOP2"
      },
      {
          "address": "DESTINATION",
          "lat": 56.86123,
          "lon": 53.24187
      }
  ]
  "services":[1,2],
  "crew_props":[1],
  "order_params":[3,4],
  "total_cost":370,
  "client_id":28,
  "use_cashless":false,
  "use_bonus":false,
  "cashless_sum":700,
  "bonus_sum":350,
  "email":"email@gmail.com",
  "prior_to_current_before_minutes":30,
  "flight_number":"130-qwe2",
  "need_custom_validate":false,
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ],
  "payment_pay_system": "qr"
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1672
  }
}

10. Расчет суммы заказа

Метод: GET

Название запроса: calc_order_cost

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&source_time=20120501100000&
is_prior=false&client_id=1&client_employee_id=11&discount_id=1&disc_card_id=1&source_zone_id=1&
dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_country=true&
waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=1;2;3&
order_params=1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
         "comment":"SUM1",
         "sum":"100"
      },
      {
         "comment":"SUM2",
         "sum":"200"
      }
    ]
  }
} 

11. Расчет суммы заказа 2

Метод: POST

Название запроса: calc_order_cost2

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/calc_order_cost2 
Signature: <...>
Content-Type: application/json
Content-Length: <...>
{
  "tariff_id":1,
  "source_time":"20140415172811",
  "is_prior":false,
  "client_id":1,  
  "discount_id":1,
  "disc_card_id":1,
  "source_zone_id":1,,
  "source_lat":11.111111,
  "source_lon":22.222222,
  "dest_zone_id":2,,
  "dest_lat":33.333333,
  "dest_lon":44.444444,
  "distance_city":10,
  "distance_country":20,
  "source_distance_country":5,
  "is_country":true,
  "waiting_minutes":10,
  "is_hourly":false,
  "hourly_minutes":60,
  "is_prize":true,
  "back_way":false,
  "order_params":[3,4],
  "stops": [
      {
          "zone_id": 1,
          "lat": 11.111111,
          "lon": 22.222222
      },
      { 
          "zone_id": 2,
          "lat": 33.333333,
          "lon": 44.444444
      }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
        "comment":"SUM1",
        "sum":"100"
      },
      {
        "comment":"SUM2",
        "sum":"200"
      }
    ]
  }
}

12. Изменение состояния заказа

Метод: POST

Название запроса: change_order_state

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/change_order_state?order_id=6&new_state=4 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":6,
    "new_state":4
  }
} 

13. Запрос информации об экипаже

Метод: GET

Название запроса: get_crew_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_id":1,
    "code":"123",
    "name":"CREW_NAME",
    "driver_id":1,
    "car_id":1,
    "crew_group_id":1,
    "crew_state_id":3,
    "online":true
    "work_shift_sum":0,
    "min_balance":10,
    "common_priority":0,
    "static_priority":0,
    "dynamic_priority":0,
    "rating_priority":0,
    "order_change_id":218,
    "has_light_house":false,
    "has_label":false,
    "fuel_level":8.15,
    "order_params":[
      1,
      2,
    ],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ]
  }
}

14. Запрос информации об экипажах

Метод: GET

Название запроса: get_crews_info

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_crews_info HTTP/1.1
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_info":[
      {
        "crew_id":1,
        "code":"123",
        "name":"CREW_NAME1",
        "driver_id":1,
        "car_id":1,
        "crew_group_id":1,
        "crew_state_id":3
        "online":true,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":10,
        "static_priority":10,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":false,
        "use_plan_shifts":false,
        "fuel_level":8.15,
        "order_params":[
          1,
          5,
        ]
      },
      {
        "crew_id":12,
        "code":"777",
        "name":"CREW_NAME2",
        "driver_id":12,
        "car_id":12,
        "crew_group_id":2,
        "crew_state_id":1,
        "online":false,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":15,
        "static_priority":15,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":true,
        "use_plan_shifts":true,
        "fuel_level":null,
        "order_params":[]
      }
    ]
  }
}

15. Создание экипажа

Метод: POST

Название запроса: create_crew

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_crew  HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id":1,
  "driver_id":2,
  "crew_group_id":3,
  "code":"CODE",
  "use_shifts":true,
  "order_params":[3,4],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "crew_id":1
 }
}

16. Обновление информации об экипаже

Метод: POST

Название запроса: update_crew_info

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_crew_info HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "crew_id":1,
  "car_id":1,
  "driver_id":3,
  "crew_group_id":3,
  "code":"CODE",
  "use_plan_shifts":true,
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

17. Запрос информации о водителе

Метод: GET

Название запроса: get_driver_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_info?driver_id=1&need_photo=false HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "driver_id":1,
    "name":"DRIVER_NAME",
    "balance":100,
    "birthday":"01.01.1980",
    "number":"111",
    "car_id":1,
    "license":"1234567890",
    "home_phone":"79999999999",
    "mobile_phone":"79999999999",
    "is_locked":false,
    "is_dismissed":false,
    "order_params":[3,4],
    "phones":[
      {
        "phone":"79999999999",
        "is_default":true,
        “use_for_call”:true
      },
      {
        "phone":"79999999999",
        "is_default":false,
        “use_for_call”:false
      }
    ],
    "term_account":"00008",
    "name_for_taxophone":"NameForTaxoPhone",
    "accounts":
    [
      {
        "account_kind":0,
        "balance":1000993.00
      },
      {
        "account_kind":1000,
        "balance":600.00
      }
    ],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ],
    "kpi":3.12
  }
}

18. Запрос списка водителей

Метод: GET

Название запроса: get_drivers_info

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_drivers_info?locked_drivers=true&dismissed_drivers=true HTTP/1.1
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "drivers_info":[
      {
        "driver_id":1,
        "name":"DRIVER_NAME1",
        "balance":100.00,
        "birthday":"01.01.1980",
        "number":"111",
        "car_id":1,
        "license":"1234567890",
        "home_phone":"79999999999",
        "mobile_phone":"79999999999",
        "is_locked":false,
        "is_dismissed":false,
        "order_params":[3,4],
        "phones":[
          {
            "phone":"79999999999",
            "is_default":true,
            “use_for_call”: true

          },
          {
            "phone":"79999999999",
            "is_default":false,
            “use_for_call”: true

          }
        ],
        "term_account":"00008",
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ],
        "kpi":3.12
      },
      {
        "driver_id":2,
        "name":"DRIVER_NAME2",
        "balance":-50.00,
        "birthday":"01.01.1980",
        "number":"222",
        "car_id":2,
        "license":"1234567899",
        "is_locked":true,
        "is_dismissed":true,
        "order_params":[5,6],
        "phones":[
          {
            "phone":"79999999999",
            "is_default":true,
            “use_for_call”: true
          },
          {
            "phone":"79999999999",
            "is_default":false,
            “use_for_call”: false
          }
        ],
        "term_account":"00009",
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ],
        "kpi":3.12
      }
    ]
  }
}

19. Создание водителя

Метод: POST

Название запроса: create_driver

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_driver HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4],
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
    {
      "phone":"79999999999",
      "is_default":true,
      “use_for_call”: true
    },
    {
      "phone":"79999999999",
      "is_default":false,
      “use_for_call”: true
    }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "driver_id":10
 }
}

20. Обновление информации о водителе

Метод: POST

Название запроса: update_driver_info

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_driver_info HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "driver_id":10
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4],
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
    {
      "phone":"79999999999",
      "is_default":true,
      “use_for_call”: true
    },
    {
      "phone":"79999999999",
      "is_default":false,
      “use_for_call”: false
    }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

21. Запрос информации об автомобиле

Метод: GET

Название запроса: get_car_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "car_id":1,
    "code":"123",
    "name":"CAR_NAME",
    "gos_number":"a123bc",
    "color":"COLOR",
    "mark":"MARK",
    "model":"MODEL",
    "short_name":"SHORT_NAME",
    "production_year":2000,
    "is_locked":false,
    "fuel_level":8.15,
    "order_params":[1,2],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ]
  }
}

22. Запрос списка автомобилей

Метод: GET

Название запроса: get_cars_info

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_cars_info?locked_cars=true HTTP/1.1
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_info":[
      {
        "car_id":1,
        "code":"111",
        "name":"CAR_1",
        "gos_number":"111111",
        "color":"COLOR_1",
        "mark":"MARK_1",
        "model":"MODEL_1",
        "short_name":"SHORT_NAME_1",
        "production_year":2000,
        "is_locked":false,
        "fuel_level":8.15,
        "order_params":[1,2],
        "attribute_values": [
            {
                  "id": 1,
                  "bool_value": true
            },
            {
                  "id": 2,
                  "num_value": 1
            }
        ]
      },
      {
        "car_id":2,
        "code":"222",
        "name":"CAR_2",
        "gos_number":"222222",
        "color":"COLOR_2",
        "mark":"MARK_2",
        "model":"MODEL_2",
        "short_name":"SHORT_NAME_2",
        "production_year":2000,
        "is_locked":false,
        "fuel_level":null,
        "order_params":[3,4],
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ]
      }
    ]
  }
}

23. Создание автомобиля

Метод: POST

Название запроса: create_car

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_car HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[1,2,3,4],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "car_id":140
 }
}

24. Обновить информацию об автомобиле

Метод: POST

Название запроса: update_car_info

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_car_info HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id":1,
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

25. Запрос координат экипажей

Метод: GET

Название запроса: get_crews_coords

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
         "crew_id":1,
         "crew_code":"111",
         "coords_time":"20120101101010",
         "lat":11.111111,
         "lon":22.222222,
         "speed":67,
         "direction":333,
         "state_kind":"waiting"
      },
      {
         "crew_id":2,
         "crew_code":"222",
         "coords_time":"20120101101010",
         "lat":33.333333,
         "lon":44.444444,
         "speed":0,
         "direction":-1,
         "state_kind":"on_order"
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_crews_coords?crew_id=1 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
         "crew_id":1,
         "crew_code":"111",
         "coords_time":"20120101101010",
         "lat":11.111111,
         "lon":22.222222,
         "state_kind":"waiting"
      }
    ]
  }
}

26. Запрос адресов, содержащих нужную строку

Метод: GET

Название запроса: get_addresses_like

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
         "address_source":"tm",
         "street":"STREET1",
         "house":"",
         "kind":"street",
         "comment":"",
         "coords":{
             "lat":0,
             "lon":0
         }
      },
      {
         "address_source":"tm",
         "street":"STREET2",
         "house":"",
         "kind":"street",
         "comment":"",
         "coords":{
             "lat":0,
             "lon":0
         }
      },
      {
         "address_source":"tm",
         "street":"POINT_STREET1",
         "house":"",
         "kind":"point",
         "comment":"Point at street STREET1",
         "coords":{
             "lat":11.111111,
             "lon":22.222222
         }
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=false&get_points=false&get_houses=true&
street=STREET1&house=1&max_addresses_count=10 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
         "address_source":"tm",
         "street":"STREET1",
         "house":"1",
         "kind":"house",
         "comment":"",
         "coords":{
             "lat":11.111111,
             "lon":22.222222
         }
      },
      {
         "address_source":"tm",
         "street":"STREET1",
         "house":"10",
         "kind":"house",
         "comment":"",
         "coords":{
             "lat":33.333333,
             "lon":44.444444
         }
      }
    ]
  }
}

27. Запрос адресов, содержащих нужную строку 2

Метод: GET

Название запроса: get_addresses_like2

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like2?get_streets=true&
get_points=true&get_houses=true&address=STR12 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
         "address_source":"tm",
         "kind":"street",
         "city":"CITY ",
         "point":"",
         "street":"STREET",
         "house":"12",        
         "comment":"",
         "coords":{
             "lat":11.11111,
             "lon":22.222222
         }
      },
      {
         "address_source":"tm",
         "kind":"street",
         "city":"CITY ",
         "point":"",
         "street":"STREET",
         "house":"120",        
         "comment":"",
         "coords":{
             "lat":11.11111,
             "lon":22.222222
         }
      }
    ]
  }
}

28. Поиск ближайшего адреса

Метод: GET

Название запроса: find_nearest_address

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/find_nearest_address?lat=56.850926&lon=53.212706&radius=100&search_in_tm=false&search_in_google=false&search_in_tmgeoservice=true HTTP/1.1
Signature: <...>

Ответ:

{
{
  "code":0,
  "descr":"OK",
  "data":
  {
    "address_source":"tmgeoservice",
    "kind":"house",
    "city":"Ижевск",
    "point":"",
    "street":"Пушкинская ул.",
    "house":"206",
    "comment":"",
    "coords":
    {
      "lat":56.850951,
      "lon":53.212822
    }
  }
}

29. Анализ маршрута

Метод: GET

Название запроса: analyze_route

Параметры:

Параметр source не является обязательным к заполнению, если заданы source_lon и source_lat.

Параметр dest не является обязательным к заполнению, если заданы dest_lon и dest_lat.

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2&
source_lon=53.153044&source_lat=56.893301&dest_lon=53.218103&dest_lat=56.869759 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "source_lat":11.111111,
    "source_lon":22.222222,
    "source_zone_id":1,
    "dest_lat":33.333333,
    "dest_lon":44.444444,
    "dest_zone_id":2,
    "city_dist":1.1,
    "country_dist":2.2,
    "source_country_dist":3.3
  }
}

30. Анализ маршрута 2

Метод: POST

Название запроса: analyze_route2

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/analyze_route2 HTTP/1.1
Content-Type: application/json
Content-Length: <...>
Signature: <...>

{
  "get_full_route_coords":true,
  "addresses":[
    {
      "address":"STREET1, 1",
      "lat":11.111111,
      "lon":22.222222
    },
    {
       "address":"STREET2, 2",
       "lat":33.333333,
       "lon":44.444444
    }
  ]
}



Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "lat":11.111111,
        "lon":22.222222,
        "zone_id":1,
        "parking_id":1
      },
      {
        "lat":33.333333,
        "lon":44.444444,
        "zone_id":2,
        "parking_id":2
      }
    ],
    "city_dist":0,
    "country_dist":2.647,
    "source_country_dist":3.412,
    "full_route_coords":[
      {
        "lat":55.833603,
        "lon":37.515537
      },
      {
        "lat":55.832855,
        "lon":37.516315
      },
      {
        "lat":55.833405,
        "lon":37.51799
      },
      ...
    ]
  }
}

31. Запрос информации о состоянии заказа

Метод: GET

Название запроса: get_order_state

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.1
Signature: <...>

Ответ: 

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1,
    "state_id":12,
    "state_kind":"car_at_place",
    "crew_id":1,
    "prior_crew_id":0,
    "driver_id":2,
    "car_id":3,
    "server_time_offset:0,
    "start_time":"20130117125641",
    "source_time":"20130117132617",
    "finish_time":"20130117130343",
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
    "source_lat":56.863613,
    "source_lon":53.186539,
    "destination":"Кирова ул. \/Ижевск\/, 56",
    "destination_lat":56.862202,
    "destination_lon":53.187485,
    "stops":[
      {
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
        "lat":56.863388,
        "lon":53.184269
      }
    ],
    "trip_distance":10.5,
    "trip_time":20,
    "customer":"Слепаков",
    "passenger":"Слепаков",
    "phone":"8800",
    "client_id":1,
    "client_employee_id":1,
    "order_crew_group_id":1,
    "tariff_id":1,
    "car_mark":"Ауди",
    "car_model":"Q7",
    "car_color":"черный",
    "car_number":"А777АА",   
    "confirmed":"confirmed_by_oper",
    "crew_coords": {
        "lat": 56.833981,
        "lon": 53.220249
    },
    "order_params":[
      1,
      2,
      5
    ],
    "creation_way":"operator",
    "is_prior":true,
    "is_really_prior":false,
    "email":"mail@mail.ru",
    "prior_to_current_before_minutes":30,
    "flight_number":"A-0501/123",
    "sum":50.5,
    "total_sum":80,
    "cash_sum":20.1,
    "cashless_sum":10,
    "bonus_sum":5.2,
    "bank_card_sum":15,
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ],
    "bill":
    [
      {
        "code":"BOARDING",
        "text":"Посадка",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"TRIP_TIME",
        "text":"Общее время",
        "value":"0:00:00",
        "sum":""
      },
      {
        "code":"TRIP_DIST",
        "text":"Общее расстояние",
        "value":"0,00 км",
        "sum":""
      },
      {
        "code":"BEFORE_DISC",
        "text":"Сумма без скидки",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"AFTER_DISC",
        "text":"Сумма со скидкой",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"MINIMUM",
        "text":"Минималка",
        "value":"",
        "sum":"60,00"
      }
    ],
    "fact_route":
    [
      {
        "lat":11.111111,
        "lon":22.222222,
        "time":"20130117132617",
        "speed":123,
        "direction":0
      }
    ],
    "is_auction":false,
    "payment_pay_system": "qr"
  }
}

32. Создание задачи СМС серверу

Метод: POST

Название запроса: send_sms

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>
Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

33. Проверка авторизации

Метод: GET

Название запроса: check_authorization

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":131
 }
}

34. Регистрация клиента

Метод: POST

Название запроса: register_client

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/register_clientHTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&
birthday=19930218115517&gender=male&address=ADDRESS&
client_group=1&parent_id=10&email=mail%40ya.ru&use_email_informing=true&
use_own_account=false

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140
  }
}

35. Регистрация клиента 2

Метод: POST

Название запроса: register_client2

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/register_client2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "name":"NAME",
  "login":"LOGIN",
  "password":"PASSWORD",
  "phones":[
    {
      "phone":"88",
      "is_default":true
    },
    {
      "phone":"99",
      "is_default":false
    }
  ],
  "address":"ADDRESS",
  "gender":"male",
  "birthday":"20000101000000",
  "client_group_id":1,
  "parent_id":10,
  "email":"mail@ya.ru",
  "use_email_informing":true,
  "comment":"TEXT",
  "use_own_account":false,
  "attribute_values":[
    {
      "id":5,
      "bool_value":true
    },
    {
      "id":7,
      "num_value":10
    },
    {
      "id":9,
      "str_value":"TEST"
    }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140
  }
}

36. Запрос информации по клиенту

Метод: GET

Название запроса: get_client_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1
Signature: <...>

Ответ:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "client_id": 20,
    "parent_id": 0,
    "name": "Юр. лицо1",
    "number": "111",
    "address": "Адрес Юр. лицо1",
    "gender": "",
    "birthday": "22.01.2016",
    "phones": [
      "105",
      "123456789",
      "100"
    ],
    "balance": 10,
    "bonus_balance": 333,
    "login": "111",
    "password": "111",
    "client_group_id": 1,
    "tariff_id": 39,
    "prize_tariff_id": 0,
    "tariff_shift_id": 0,
    "discount_id": 2,
    "prize_discount_id": 0,
    "min_balance": 0,
    "min_balance_for_use_cashless": null,
    "min_bonus_balance_for_use_bonus": null,
    "is_locked": false,
    "lock_description": "",
    "use_cashless_account": true,
    "use_cashless": true,
    "remain_prize": 0,
    "email": "Юр. лицо1@ss.ru",
    "use_email_informing": true,
    "default_crew_group": 6,
    "comment": "Сотрудник СВР. Использовать максимальные скидки",
    "employees": [
      {
        "client_id": 323,
        "parent_id": 20,
        "name": "Сотрудник1",
        "number": "111",
        "address": "Адрес Сотрудник1",
        "gender": "",
        "birthday": null,
        "phones": [
          "11221122112211"
        ],
        "balance": 0,
        "bonus_balance": 0,
        "login": "",
        "password": "",
        "client_group_id": 1,
        "tariff_id": 17,
        "prize_tariff_id": 0,
        "tariff_shift_id": 0,
        "discount_id": 2,
        "prize_discount_id": 0,
        "min_balance": 0,
        "min_balance_for_use_cashless": null,
        "min_bonus_balance_for_use_bonus": null,
        "is_locked": false,
        "lock_description": "",
        "use_cashless": true,
        "remain_prize": 0,
        "email": "Сотрудник1@ss.ru",
        "use_email_informing": true,
        "default_crew_group": 6,
        "accounts": [
          {
            "account_kind": 0,
            "balance": 400.00,
            "balance_with_children": 0.00
          },
          {
            "account_kind": 1,
            "balance": 0.00,
            "balance_with_children": 0.00
          },
          {
            "account_kind": 1003,
            "balance": 100.00,
            "balance_with_children": 0.00
          }
        ],
        "attribute_values": [
          {
            "id": 5,
            "bool_value": true
          },
          {
            "id": 4,
            "bool_value": true
          }
        ]
      }
    ],
    "accounts": [
      {
        "account_kind": 0,
        "balance": 2355.00,
        "balance_with_children": 2755.00
      },
      {
        "account_kind": 1,
        "balance": 0.00,
        "balance_with_children": 0.00
      },
      {
        "account_kind": 1003,
        "balance": -20.00,
        "balance_with_children": 80.00
      }
    ],
    "attribute_values": [
      {
        "id": 4,
        "bool_value": true
      }
    ]
  }
}

37. Запрос информации по клиентам

Метод: GET

Название запроса: get_clients_info

Параметры:

Специальные возвращаемые коды: Нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_clients_info?text=test&max_clients_count=10&client_group_id=1&
parent_id=20&fields=name,number HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "clients_info":[
      {
        "client_id":390,
        "name":"tester1",
        "number":"001"
      },
      {
        "client_id":394,
        "name":"tester2",
        "number":"002"
      }
    ]
  }
}

38. Изменение информации по клиенту

Метод: POST

Название запроса: update_client_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/update_client_info HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&
birthday=20140901000000&gender=male&address=ADDRESS&parent_id=10&
client_group_id=3&email=mail%40ya.ru&use_email_informing=true

Ответ:

{
 "code":0,
  "descr":"OK",
  "data":{}
}

39. Изменение информации по клиенту 2

Метод: POST

Название запроса: update_client_info2

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/update_client_info2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "client_id":140,
  "name":"NAME",
  "login":"LOGIN",
  "password":"PASSWORD",
  "phones":[
    {
      "phone":"88",
      "is_default":true
    }
  ],
  "address":"ADDRESS",
  "gender":"male",
  "birthday":"20000101000000",
  "client_group_id":1,
  "parent_id":10,
  "email":"mail@ya.ru",
  "use_email_informing":true,
  "comment":"TEXT",
  "use_own_account":false,
  "attribute_values":[
    {
      "id":7,
      "num_value":5
    },
    {
      "id":9,
      "str_value":null
    }
  ]
}

Ответ:

{
 "code":0,
  "descr":"OK",
  "data":{}
}

40. Запрос текущих заказов

Метод: GET

Название запроса: get_current_orders

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "orders":[
      {
        "order_id":1,
        "state_id":12,
        "state_kind":"car_at_place",
        "crew_id":1,
        "prior_crew_id":0,
        "driver_id":2,
        "car_id":3,
        "server_time_offset":0,
        "start_time":"20130117125641",
        "source_time":"20130117132617",
        "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
        "source_lat":56.863613,
        "source_lon":53.186539,
        "destination":"Кирова ул. \/Ижевск\/, 56",
        "destination_lat":56.862202,
        "destination_lon":53.187485,
        "stops":[
          {
            "address":"30 Лет Победы ул. \/Ижевск\/, 8",
            "lat":56.863388,
            "lon":53.184269
          }
        ],
        "customer":"Слепаков",
        "passenger":"Слепаков",
        "phone":"8800",
        "client_id":1,
        "client_employee_id":1,
        "order_crew_group_id":1,
        "tariff_id":1,
        "car_mark":"Ауди",
        "car_model":"Q7",
        "car_color":"черный",
        "car_number":"А777АА",
        "confirmed":"confirmed_by_oper",
        "crew_coords":{
          "lat":56.833981,
          "lon":53.220249
        },
        "order_params":[
          1,
          2,
          5
        ],
        "creation_way":"operator",
        "is_prior":true,
        "is_really_prior":false,
        "email":"mail@mail.ru",
        "prior_to_current_before_minutes":30,
        "flight_number":"A-0501/123",
        "sum":50.5,
        "total_sum":80,
        "cash_sum":20.1,
        "cashless_sum":10,
        "bonus_sum":5.2,
        "bank_card_sum":15,
        "attribute_values":[
          {
            "id":1,
            "bool_value":true
          },
          {
            "id":2,
            "num_value":1
          },
          {
            "id":3,
            "num_value":10
          },
          {
            "id":4,
            "str_value":"строка"
          }
        ],
        "bill":[
          {
            "code":"BOARDING",
            "text":"Посадка",
            "value":"",
            "sum":"20,00"
          },
          {
            "code":"TRIP_TIME",
            "text":"Общее время",
            "value":"0:00:00",
            "sum":""
          },
          {
            "code":"TRIP_DIST",
            "text":"Общее расстояние",
            "value":"0,00 км",
            "sum":""
          },
          {
            "code":"BEFORE_DISC",
            "text":"Сумма без скидки",
            "value":"",
            "sum":"20,00"
          },
          {
            "code":"AFTER_DISC",
            "text":"Сумма со скидкой",
            "value":"",
            "sum":"20,00"
          },
          {
            "code":"MINIMUM",
            "text":"Минималка",
            "value":"",
            "sum":"60,00"
          }
        ],
        "is_auction":false,
        "payment_pay_system":"qr"
      }
    ]
  }
}

41. Запрос выполненных заказов

Метод: GET

Название запроса: get_finished_orders

Параметры:

Примечание: должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_finished_orders?start_time=20220405142210&finish_time=20220405142710&
fields=state_id,crew_id,prior_crew_id,driver_id,car_id,server_time_offset,start_time,
source_time,finish_time,source,source_lat,source_lon,destination,destination_lat,
destination_lon,stops,trip_distance,trip_time,customer,passenger,phone,phone_to_dial,
client_id,client_name,client_group_id,client_group_name,client_employee_id,
order_crew_group_id,tariff_id,order_params,attribute_values,creation_way,is_prior,
email,flight_number,sum,total_sum,cash_sum,cashless_sum,bonus_sum,
bank_card_sum,car_mark,car_model,car_color,car_number,bill
 HTTP/1.1
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":
  {
    "orders":
    [
      {
        "id":47834,
        "state_id":4,
        "crew_id":17,
        "prior_crew_id":0,
        "driver_id":17,
        "car_id":16,
        "server_time_offset":0,
        "start_time":"20220405142418",
        "source_time":"20220405142418",
        "finish_time":"20220405142708",
        "source":"5-Я ЯМСКОГО ПОЛЯ УЛ., 37",
        "source_lat":56.853062,
        "source_lon":53.20715,
        "destination":"ХОДЫНСКАЯ УЛ., 10А",
        "destination_lat":0,
        "destination_lon":0,
        "stops":
        [],
        "trip_distance":10,
        "trip_time":3600,
        "customer":"Client 89872977005",
        "passenger":"",
        "phone":"89872977005",
        "phone_to_dial":"",
        "client_id":43111,
        "client_name":"Client 89872977005",
        "client_group_id":2,
        "client_group_name":"Физические",
        "client_employee_id":0,
        "order_crew_group_id":0,
        "tariff_id":2,
        "order_params":
        [
          28,
          29,
          30,
          55,
          58,
          59,
          62
        ],
        "attribute_values":
        [
          {
            "id":28,
            "num_value":0
          },
          {
            "id":29,
            "num_value":0
          },
          {
            "id":30,
            "num_value":0
          },
          {
            "id":55,
            "num_value":1
          },
          {
            "id":58,
            "num_value":0
          },
          {
            "id":59,
            "num_value":0
          },
          {
            "id":62,
            "num_value":0
          }
        ],
        "creation_way":"operator",
        "is_prior":false,
        "email":"",
        "flight_number":"",
        "sum":100,
        "total_sum":100,
        "cash_sum":50,
        "cashless_sum":40,
        "bonus_sum":10,
        "bank_card_sum":0,
        "car_mark":"Баф",
        "car_model":"Fenix 3346",
        "car_color":"белая",
        "car_number":"а111аа",
        "is_auction":false,
        "payment_pay_system": "qr"
      }
    ]
  }
}

42. Проведение операции по клиенту

Метод: POST

Название запроса: create_client_operation

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&
pay_type=cash&comment=COMMENT&account_kind=0

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "oper_id":31

  }
}

43. Запрос операций по клиенту

Метод: GET

Название запроса: get_client_operations

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112&account_kind=0 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":111,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "pay_type":"cash",
        "account_kind":0,
        "name":"Пополнение счета",
        "comment":"Комментарий",
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "pay_type":"cash",
        "account_kind":0,
        "name":"Пополнение счета",
        "comment":"Комментарий"
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}

44. Проведение операции по водителю

Метод: POST

Название запроса: create_driver_operation

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_driver_operation HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "driver_id": 1,
    "oper_sum": 10.00,
    "oper_type": "receipt",
    "name": "Пополнение счета",
    "oper_time": "20141210100719",
    "comment": "Комментарий к операции",
    "account_kind": 1
}

Ответ:

{
   "code":0,
   "descr":"OK",
   "data":{
   "oper_id":31
   }
}

45. Запрос операций по водителю

Метод: GET

Название запроса: get_driver_operations

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_operations?driver_id=112&
start_time=20130201092112&finish_time=20130221092112 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":111,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_1",
        "comment":"DRIVER_OPERATION_COMMENT_1",
        "account_kind":0,
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_2",
        "comment":"DRIVER_OPERATION_COMMENT_2",
        "account_kind":0,
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}

46. Назначение динамического приоритета водителю

Метод: POST

Название запроса: create_driver_dyn_priority

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_driver_dyn_priority HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "driver_id": 1,
    "priority": 10,
    "start_time": "20150101100000",
    "finish_time": "20150101200000",
    "name": "За выполнение заказа в отдаленный район"
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "dyn_priority_id":123
  }
}

47. Задание координат экипажей

Метод: POST

Название запроса: set_crews_coords

Параметры в формате JSON:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/set_crews_coords HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "crews_coords":[
    {
      "crew_id":1,
      "lat":11.111111,
      "lon":22.222222,
      "speed":66.66,
      "direction":333
    },
    {
      "gps_id":2,
      "lat":33.333333,
      "lon":44.444444
    }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

48. Изменение информации по заказу

Метод: POST

Название запроса: update_order

Параметры в формате JSON:

Специальные возвращаемые коды:

  "data": {
    "message":"Текст ошибки для пользователя."
  }

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

POST https://ip:port/common_api/1.0/update_order HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "order_id": 12105,
    "phone": "555",
    "source_time": "20141216095044",
    "is_prior": true,
    "auto_select_discount": true,
    "auto_select_tariff": true,
    "auto_recalc_cost": true,
    "auto_update_order_params": true,
    "customer": "Заказчик",
    "passenger": "Пассажир",
    "comment": "Комментарий",
    "crew_group_id": 8,
    "client_id": 30,
    "tariff_id": 33,
    "addresses":[
       {"address":"SOURCE","lat":56.896817,"lon":53.147830},       
       {"address":"STOP1","lat":56.845452,"lon":53.226775},
       {"address":"STOP2"}, 
       {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
    ],
    "cost_order": 200,
    "state_id": 55,
    "discount_id": 1,
    "email" : "mail@mail.ru",
    "prior_to_current_before_minutes":30,
    "flight_number":"Number",
    "need_custom_validate":false,
    "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

49. Анализ телефона

Метод: GET

Название запроса: analyze_phone

Параметры:

Если параметры search_in_drivers_mobile, search_in_clients, search_in_phones не заданы, то поиск телефона будет происходить во всех справочниках.

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/analyze_phone?phone=89501234567&search_in_drivers_mobile=true&
search_in_clients=true&search_in_phones=true HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
  "phone_type":"client",
  "id":1
  "client_employee_id":2
   }
}

50. Показать сообщение в ТМ

Метод: POST

Название запроса: show_tm_message

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/show_tm_message HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "text": "Текст сообщения",
    "type": "warning",
    "users": [
        1,
        2,
        3
    ],
    "header": "Заголовок",
    "timeout": 12,
    "color":"#FFFF80",
    "car_id":55
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

51. Запрос списка купленных смен водителей

Метод: GET

Название запроса: get_driver_shifts

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_shifts?start_time=20140101101010&finish_time=20140101202020 
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "shifts":[
      {
        "shift_id":1,
        "driver_id":1,
        "driver_name":"DRIVER_1",
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":false,
        "return_time":null,
        "orders_count":10,
        "orders_sum":1000,
        "fact_length":1.2
      },
      {
        "shift_id":2,
        "driver_id":2,
        "driver_name":"DRIVER_2",
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":null,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":true,
        "return_time":"20140101101010",
        "orders_count":0,
        "orders_sum":0,
        "fact_length":0
      }
    ]
  }
}

52. Запрос списка запланированных смен водителей

Метод: GET

Название запроса: get_driver_plan_shifts

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_plan_shifts?start_time=20140101101010&
finish_time=20140101202020 HTTP/1.1
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "plan_shifts":[
      {
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "max_sell_count":100,
        "sold_count":10
      },
      {
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":2,
        "max_sell_count":200,
        "sold_count":20
      }
    ]
  }
}

53. Продажа смены водителю

Метод: POST

Название запроса: driver_buy_shift

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:

POST https://ip:port/common_api/1.0/driver_buy_shift HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

crew_id=1&plan_shift_id=1


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

54. Сохранение отзыва клиента

Метод: POST

Название запроса: save_client_feed_back

Параметры в формате JSON:

Допускается указывать либо параметр rating, либо text, либо оба параметра.

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/save_client_feed_back HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "phone":"89123456789",
  "rating":4,
  "text":"test feedback",
  "order_id":100
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

55. Поиск экипажей по координатам

Метод: GET

Название запроса: find_crews_by_coords

Параметры:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
GET https://ip:port/common_api/1.0/find_crews_by_coords?lat=11.111111&
lon=22.222222&radius=2&crews_release_in=5&attributes=1;2;3 HTTP/1.1
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "waiting_count":5,
    "on_order_count":2
  }
}

56. Подбор тарифа для заказа

Метод: POST

Название запроса: select_tariff_for_order

Параметры в формате JSON:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:
POST https://ip:port/common_api/1.0/select_tariff_for_order HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "client_id":1,
  "crew_group_id":2,
  "source_time":"20160101100000",
  "is_prize":true,
  "addresses": [
      {
          "lat": 11.111111,
          "lon": 22.222222
      },
      { 
          "lat": 33.333333,
          "lon": 44.444444
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "tariff_id":2
 }
}

57. Импорт марок автомобилей в БД

Метод: POST

Название запроса: import_car_marks

Параметры в формате JSON:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/import_car_marks HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "marks": [
    "Mercedes",
    "BMW"
  ]
}

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

58. Импорт цветов автомобилей в БД

Метод: POST

Название запроса: import_car_colors

Параметры в формате JSON:

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/import_car_colors HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "colors": [
    "красный",
    "синий"
  ]
}

 Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

59. Запрос информации по сотруднику клиента

Метод: GET

Название запроса: get_client_employee_info

Параметры:

Специальные возвращаемые коды:

Возвращаемые данные в случае успешного выполнения запроса:

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_employee_info?client_employee_id=10 HTTP/1.1
Signature: <...>

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{
     "client_employee_id":5,
    "client_id":1,
    "name":"Иванов Иван",
    "is_deleted":false,
    "email":"mail@mail.ru",
    "use_email_informing":true,
    "default_crew_group":1,
    "phones":[
      {
        "phone":"88"
      },
      {
        "phone":"99"
      }
    ]
  }
 }

60. Создание сотрудника клиента

Метод: POST

Название запроса: create_client_employee

Параметры в формате JSON:

Специальные возвращаемые коды: