Общая информация
Параметр Значение
API URL https://tt-ok.ru/data/api
API KEY API — платный дополнительный модуль. API KEY высылается клиенту по электроннной почте после подключения данной возможности.
Метод передачи данных POST
Возвращаемые значения JSON содержащий:
- error_code (1 - есть ошибки, 0 - нет ошибок)
- error_text (текст ошибки)
- data (данные, если они требуется к возврату)
Параметры POST
Параметр Тип Комментарий
data Строка JSON
method Строка Допустимые значения:
- CreateOrder
- CreateClient
- GetOrders
- GetClients
- GetCarriers
- GetTransports
- GetDrivers
random Строка Любая не пустая строка
signature Строка Подпись данных.
Алгоритм формирования подписи:
md5(API KEY + '###' + data + '###' + method + '###' + random + '###' + API KEY)
Метод CreateOrder
Параметр Комментарий
Назначение метода Создание заказа
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Параметр Client Наименование клиента.
Не пустая строка. Обязательный параметр. Передается в параметре data.
Параметр ContactFace Имя контактного лица клиента.
Строка. Передается в параметре data.
Параметр AutoType Наименование типа транспорта.
Строка. Передается в параметре data.
Параметр BeginDateTime Дата/время начала заказа.
Строка. Формат: YYYY-MM-DD HH:MM:SS или пустая строка. Передается в параметре data.
Параметр EndDateTime Дата/время окончания закаха.
Строка. Формат: YYYY-MM-DD HH:MM:SS или пустая строка. Передается в параметре data.
Параметр Load Адрес загрузки.
Строка. Передается в параметре data.
Параметр Unload Адрес выгрузки.
Строка. Передается в параметре data.
Параметр User Имя менеджера заказа.
Строка. Передается в параметре data.
Параметр Cargo Наименование груза.
Строка. Передается в параметре data.
Параметр PlaceCount Количество мест груза.
Строка. Передается в параметре data.
Параметр Volume Объем груза.
Строка. Передается в параметре data.
Параметр Weight Вес груза.
Строка. Передается в параметре data.
Параметр Package Комплектация груза.
Строка. Передается в параметре data.
Параметр Conditions Особые условия для груза.
Строка. Передается в параметре data.
Параметр LoadType Тип загрузки.
Строка. Передается в параметре data.
Параметр UnloadType Тип выгрузки.
Строка. Передается в параметре data.
Параметр Comment Комментарий по заказу.
Строка. Передается в параметре data.
Параметр Firm Наименование нашей фирмы, оказывающей услуги клиенту.
Строка. Передается в параметре data.
Параметр ClientSum Сумма заказа.
Положительное число, 2 знака после запятой или пустая строка. Передается в параметре data.
Параметр WorkerSum Сумма исполнителю.
Положительное число, 2 знака после запятой или пустая строка. Передается в параметре data.
Параметр FixPrice Фиксированная ставка.
Целочисленное значение. 1 — использование фиксированных тарифов. 0 — обычная тарификация. Передается в параметре data.
Параметр ClientPayType Способ расчета с клиентом.
Строка. Варианты значений: наличные, с НДС, без НДС, карта. Передается в параметре data.
Параметр WorkerPayType Способ расчета с исполнителем.
Строка. Варианты значений: наличные, с НДС, без НДС, карта. Передается в параметре data.
Параметр Worker Наименование исполнителя.
Строка. Передается в параметре data.
Параметр Transport Госномер транспортного средства.
Строка. Передается в параметре data.
Параметр Trailer Госномер прицепа
Строка. Передается в параметре data.
Параметр Driver Имя водителя
Строка. Передается в параметре data.
Параметр OrderNum Произвольный номер заказа.
Строка. Передается в параметре data.
Параметр ClientOrderNum Номер заказа клиента.
Строка. Передается в параметре data.
Параметр LoadContactFace Контактное лицо на загрузке.
Строка. Передается в параметре data.
Параметр LoadContactFacePhone Номер телефона контактного лица на загрузке.
Строка. Передается в параметре data.
Параметр UnloadContactFace Контактное лицо на разгрузке.
Строка. Передается в параметре data.
Параметр UnloadContactFacePhone Номер телефона контактного лица на разгрузке.
Строка. Передается в параметре data.
Параметр CargoSender Грузоотправитель.
Строка. Передается в параметре data.
Параметр CargoReceiver Грузополучатель.
Строка. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1,
  "BeginDateTime": "2023-01-20 10:00:00",
  "EndDateTime": "2023-01-20 16:20:00",
  "Client": "ООО Альфа",
  "ContactFace": "Иванов Иван",
  "AutoType": "Изотерм",
  "Load": "ул. Марата, д. 51, лит. А",
  "Unload": "ул. Александра Солженицына, 20",
  "User": "Алтунин Стас",
  "Cargo": "Сантехника",
  "PlaceCount": "10",
  "Volume": "-",
  "Weight": "-",
  "Package": "Коробки",
  "Conditions": "-",
  "LoadType": "-",
  "UnloadType": "-",
  "Comment": "-",
  "Firm": "АвтоСтарт",
  "ClientSum": 100000,
  "WorkerSum": 75000,
  "FixPrice": 1,
  "ClientPayType": "без НДС",
  "WorkerPayType": "карта",
  "Worker": "Прогресс-Авто",
  "Transport": "Р605ОМ777",
  "Trailer": "Т250ЛО777",
  "Driver": "Сидоров Олег",
  "OrderNum": "МА-5210",
  "ClientOrderNum": "К852",
  "LoadContactFace": "Иванов",
  "LoadContactFacePhone": "+71231234567",
  "UnloadContactFace": "Петров",
  "UnloadContactFacePhone": "+71231234567",
  "CargoSender": "Компания 1",
  "CargoReceiver": "Компания 2"
}

{
  "api_user_id": 1,
  "Client": "ООО Альфа"
}
Примеры возвращаемого значения
{
    "error_code": 1,
    "error_text": "Некорректные данные в параметре Client",
    "data": []
}

{
    "error_code": 0,
    "error_text": "",
    "data": {
        "order_id": 123
    }
}
Метод CreateClient
Параметр Комментарий
Назначение метода Создание Клиента
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Параметр Title Краткое наименование клиента.
Не пустая строка. Обязательный параметр. Передается в параметре data.
Параметр Group Наименование категории клиента.
Строка. Передается в параметре data.
Параметр Phone Номер телефона клиента.
Строка. Передается в параметре data.
Параметр EMail Адрес электронной почты клиента.
Строка. Передается в параметре data.
Параметр INN ИНН клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр KPP КПП клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр OGRN ОГРН клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр Address Юридический адрес клиента.
Строка. Передается в параметре data.
Параметр FactAddress Фактический адрес клиента.
Строка. Передается в параметре data.
Параметр PostAddress Почтовый адрес клиента.
Строка. Передается в параметре data.
Параметр BankAccount Номер банковского расчетного счета клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр Bank Наименование банка клиента.
Строка. Передается в параметре data.
Параметр CorAccount Корреспондентский счет банка клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр BIK БИК банка клиента.
Строка, состоящая из цифр, или пустая строка. Передается в параметре data.
Параметр ContactFace Имя контактного лица клиента.
Строка. Передается в параметре data.
Параметр ContactFacePhone Номер телефона контатного лица клиента.
Строка. Передается в параметре data.
Параметр ContactFaceEMail Адрес электронной почты контатного лица клиента.
Строка. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1,
  "Title": "ООО Альфа",
  "Group": "Постоянный клиент",
  "Phone": "+7(4722)500662",
  "EMail": "cargo@alpha.ru",
  "INN": "6679032155",
  "KPP": "667901001",
  "OGRN": "1136679005792",
  "Address": "620130, г Екатеринбург, ул Степана Разина, д 122, кв 206",
  "FactAddress": "620130, Екатеринбург город, Степана Разина улица, дом 122",
  "PostAddress": "620130, Екатеринбург город, Степана Разина улица, дом 122",
  "BankAccount": "40802810720160006939",
  "Bank": "Филиал "Центральный" Банка ВТБ (ПАО) г. Москва",
  "CorAccount": "30101810145250000411",
  "BIK": "044525411",
  "ContactFace": "Иванов Иван",
  "ContactFacePhone": "+79036420662",
  "ContactFaceEMail": "ivan@alpha.ru"
}

{
  "api_user_id": 1,
  "Title": "ООО Альфа"
}
Примеры возвращаемого значения
{
    "error_code": 1,
    "error_text": "Клиент с таким Title уже существует",
    "data": []
}

{
    "error_code": 0,
    "error_text": "",
    "data": {
        "client_id": 456
    }
}
Метод GetOrders
Параметр Комментарий
Назначение метода Получение списка заказов
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Параметр ClientId Идентификатор клиента.
Целое положительное число. Передается в параметре data.
Параметр OrderId Номер заказа.
Целое положительное число. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1,
  "ClientId": 12345
}

{
  "api_user_id": 1,
  "OrderId": 1001
}

{
  "api_user_id": 1
}
Пример возвращаемого значения
{
    "error_code": 0,
    "error_text": "",
    "data": [
        {
            "ID": "1",
            "Number": "1",
            "Client": "ООО Альфа",
            "ContactFace": "Иванов Виван",
            "BeginDateTime": "2023-01-20 10:00:00",
            "EndDateTime": "2023-01-20 16:00:00",
            "Load": "Казань",
            "Unload": "Киров",
            "Cargo": "Бытовая химия",
            "PlaceCount": "55",
            "Volume": "72",
            "Weight": "1270",
            "Package": "палеты",
            "Conditions": "",
            "LoadType": "задняя",
            "UnloadType": "задняя",
            "AutoType": "-",
            "Worker": "Прогресс-Авто",
            "Agent": "Петров Петр",
            "TransportBrand": "Scania",
            "TransportNumber": "Р605ОМ777",
            "Driver": "Сидоров Олег",
            "ClientSum": "27300",
            "WorkerSum": "21000",
            "Firm": "АвтоСтарт",
            "User": "Алтунин Стас",
            "Status": "В пути"
        }
    ]
Метод GetClients
Параметр Комментарий
Назначение метода Получение списка клиентов
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1
}
Пример возвращаемого значения
{
  "error_code": 0,
  "error_text": "",
  "data": [
    {
      "ID": "1",
      "Title": "ООО Альфа",
      "FirmName": "ООО Альфа",
      "Group": "Корпоративный клиент",
      "Phone": "+7(4722)500662",
      "EMail": "cargo@alpha.ru",
      "INN": "6679032155",
      "KPP": "667901001",
      "OGRN": "1136679005792",
      "Address": "620130, г Екатеринбург, ул Степана Разина, д 122, кв 206",
      "FactAddress": "620130, Екатеринбург город, Степана Разина улица, дом 122",
      "PostAddress": "620130, Екатеринбург город, Степана Разина улица, дом 122",
      "BankAccount": "40802810720160006939",
      "Bank": "Филиал Центральный Банка ВТБ (ПАО) г. Москва",
      "CorAccount": "30101810145250000411",
      "BIK": "044525411",
      "Contacts": [
        {
          "ID": "1",
          "ContactName": "Иванов Иван",
          "ContactPhone": [
            ""
          ],
          "ContactEMail": "ivan@alpha.ru",
          "ContactSkype": "",
          "ContactICQ": ""
        },
        {
          "ID": "10",
          "ContactName": "Фролов Кирилл",
          "ContactPhone": [
            "+71231234567",
            "+71237654321"
          ],
          "ContactEMail": "kir@alpha.ru",
          "ContactSkype": "",
          "ContactICQ": ""
        }
      ]
    }
  ]
}
Метод GetCarriers
Параметр Комментарий
Назначение метода Получение списка исполнителей с контактными лицами, привязанными машинами и водителями
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1
}
Пример возвращаемого значения
{
    "error_code": 0,
    "error_text": "",
    "data": [
        {
            "ID": "1",
            "Title": "Перевозчик",
            "FirmName": "ООО Перевозчик",
            "Group": "Область",
            "Phone": [
                ""
            ],
            "EMail": "",
            "INN": "7805807551",
            "KPP": "780501001",
            "OGRN": "1237800080044",
            "Address": "198095, г. Санкт-Петербург, пер Химический, д. 1, литера АН, помещ. 4Н, офис 403",
            "FactAddress": "198095, г. Санкт-Петербург, пер Химический, д. 1, литера АН, помещ. 4Н, офис 403",
            "PostAddress": "198095, г. Санкт-Петербург, пер Химический, д. 1, литера АН, помещ. 4Н, офис 403",
            "BankAccount": "40802810720160006939",
            "Bank": "Филиал Центральный Банка ВТБ (ПАО) г. Москва",
            "CorAccount": "30101810145250000411",
            "BIK": "044525411",
            "Contacts": [
                {
                    "ID": "2",
                    "ContactName": "Петров Петр",
                    "ContactPhone": [
                        "79036420662"
                    ],
                    "ContactEMail": "petrov-cargo@yandex.ru",
                    "ContactSkype": "",
                    "ContactICQ": ""
                }
            ],
            "Transports": [
                {
                    "ID": "2",
                    "TransportBrand": "Вольво",
                    "TransportNumber": "Т459ЕН52",
                    "TransportType": "Тент, 20 тонн",
                    "Length": "13.4",
                    "Width": "2.47",
                    "Height": "2.7",
                    "LoadCapacity": "20",
                    "PalletCount": "33",
                    "Year": "2007",
                    "RegDoc": "",
                    "Drivers": [
                        {
                            "ID": "53",
                            "Driver": "Смирнов Виктор Семенович",
                            "DriverPhone": [
                                "79036420662"
                            ],
                            "DriverPassport": "\r\n\r\n\r\n\r\n",
                            "DriverLicense": "",
                            "DriverCaterories": "",
                            "RegistrationAddress": "",
                            "ResidentialAddress": "",
                            "TaxNumber": "",
                            "BirthDate": ""
                        },
                        {
                            "ID": "75",
                            "Driver": "Дубаев Игорь Сергеевич ",
                            "DriverPhone": [
                                "79036420662"
                            ],
                            "DriverPassport": "\r\n\r\n\r\n\r\n",
                            "DriverLicense": "",
                            "DriverCaterories": "",
                            "RegistrationAddress": "",
                            "ResidentialAddress": "",
                            "TaxNumber": "",
                            "BirthDate": ""
                        }
                    ]
                }
            ]
        },
        {
            "ID": "2",
            "Title": "Мечта Логиста",
            "FirmName": "ООО Мечта Логиста",
            "Group": "Страна",
            "Phone": [
                ""
            ],
            "EMail": "",
            "INN": "",
            "KPP": "",
            "OGRN": "",
            "Address": "",
            "FactAddress": "",
            "PostAddress": "",
            "BankAccount": "",
            "Bank": "",
            "CorAccount": "",
            "BIK": ""
        }
    ]
}
Метод GetTransports
Параметр Комментарий
Назначение метода Получение списка транспортных средств
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1
}
Пример возвращаемого значения
{
    "error_code": 0,
    "error_text": "",
    "data": [
        {
            "ID": "1",
            "TransportBrand": "Скания",
            "TransportNumber": "Н975РВ77",
            "TransportType": "Тент, 15 тонн",
            "Length": "8",
            "Width": "2.5",
            "Height": "2.6",
            "LoadCapacity": "16",
            "PalletCount": "18",
            "Year": "2010",
            "RegDoc": ""
        },
        {
            "ID": "2",
            "TransportBrand": "Вольво",
            "TransportNumber": "Т459ЕН52",
            "TransportType": "Тент, 20 тонн",
            "Length": "13.4",
            "Width": "2.47",
            "Height": "2.7",
            "LoadCapacity": "20",
            "PalletCount": "33",
            "Year": "2007",
            "RegDoc": ""
        }
    ]
}
Метод GetDrivers
Параметр Комментарий
Назначение метода Получение списка водителей
Параметр api_user_id Id пользователя API — высылается клиенту по электроннной почте после подключения данной возможности.
Целое положительное число. Обязательный параметр. Передается в параметре data.
Примеры параметра data
{
  "api_user_id": 1
}
Пример возвращаемого значения
{
    "error_code": 0,
    "error_text": "",
    "data": [
        {
            "ID": "1",
            "Driver": "Набоков Андрей Павлович",
            "DriverPhone": [
                "79036420662"
            ],
            "DriverPassport": "11 22  850128\r\n03.04.2007\r\nОтделом внутренних дел Изобильненского района Ставропольского края\r\n262-010\r\n",
            "DriverLicense": "33 44 779873",
            "DriverCaterories": "",
            "RegistrationAddress": "",
            "ResidentialAddress": "",
            "TaxNumber": "",
            "BirthDate": "1988-06-14"
        },
        {
            "ID": "2",
            "Driver": "Шибаев Леонид Сергеевич",
            "DriverPhone": [
                "79036420662",
                "89874124300"
            ],
            "DriverPassport": "92 09  795952\r\n21.10.2009\r\nотделением УФМС России\r\n\r\n",
            "DriverLicense": "99 15 682010",
            "DriverCaterories": "",
            "RegistrationAddress": "",
            "ResidentialAddress": "",
            "TaxNumber": "",
            "BirthDate": "1984-10-15"
        }
    ]
}
Передача данных по API
API KEY *
Метод (параметр method) *
Данные, JSON (параметр data) *

Поля, отмеченные *, обязательны для заполнения.