API сайта CMR24.by

Список API

  1. Получение ID городов
  2. Виды погрузки
  3. Типы кузова
  4. Виды валют
  5. Формы оплаты
  6. Добавление груза и транспорта
  7. Получение списка размещенных грузов и транспорта
  8. Изменение груза или транспорта
  9. Удаление, архивирование груза или транспорта
  10. Восстановление заявки из архива

Описание

API предназначены для взаимодействия с CMR24. Для обращения к любым функциям сервиса необходимо наличие авторизационного ключа "authkey", который выдается администрацией CMR24 при подключении к API.

Базовый URL: https://cmr24.by/api/

Обязательный параметр GET: authkey

Пример: https://cmr24.by/api/currencies?authkey=ваш_authkey

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

Получение ID городов

https://cmr24.by/api/cities
ЗАПРОС GET
ОТВЕТ
#
Параметр
Описание
Тип
1
Cities

Список городов

Пример:

0 => [
     id => 282,
     text => «Минск (Беларусь)»
    ],
1 => [
     id => 17790,
     text => «Миоры (Беларусь)»
    ],
...
Массив

Виды погрузки

https://cmr24.by/api/load-types
ЗАПРОС GET
ОТВЕТ
#
Параметр
Описание
Тип
1
LoadTypes

Список

Пример:

0 => "Задняя",
1 => "Боковая",
...
Массив

Типы кузова

https://cmr24.by/api/body-types
ЗАПРОС GET
ОТВЕТ
#
Параметр
Описание
Тип
1
BodyTypes

Список

Пример:

10 => "Крытое",
1 => "Тент",
...
Массив

Виды валют

https://cmr24.by/api/currencies
ЗАПРОС GET
ОТВЕТ
#
Параметр
Описание
Тип
1
Currencies

Список

Пример:

10 => "AMD",
1 => "BYN",
...
Массив

Формы оплаты

https://cmr24.by/api/payment-forms
ЗАПРОС GET
ОТВЕТ
#
Параметр
Описание
Тип
1
PaymentForms

Список

Пример:

1 => "Безнал",
3 => "Карта",
...
Массив

Добавление груза и транспорта

https://cmr24.by/api/add-cargo
ЗАПРОС POST
Используется массив Cargo с ниже перечисленными параметрами
т.е. Cargo[date_from], Cargo[date_to] ...

Для тестирования подключения к API используйте функцию "add-cargo-in-archive". Она аналогична данной функции, за исключением того, что заявки попадают в архив и не публикуются на сайте.
Обязательное поле.
Ответ
Ошибка — 404.
В случае успеха — отстуствие ошибки.

Получение списка размещенных грузов и транспорта

https://cmr24.by/api/cargo-list
ЗАПРОС GET
Параметры отсутствуют
ОТВЕТ
#
Параметр
Описание
Тип
1
Cargo

Список грузов и транспорта

Пример:

    0 => [
         id => 282,
         type => 0,
         status => 0,
         name => «Название груза»,
         ..
        ],
    1 => [
         id => 17790,
         type => 1,
         status => 1,
         id_city_from => 3,
        ],
    ...

type=0 - Груз
type=1 - Транспорт
status=0 - Активный
status=1 - Архив
остальные поля, как при добавлении груза
Массив,

Изменение груза или транспорта

https://cmr24.by/api/cargo-edit
ЗАПРОС POST
Используются название полей, как при добавлении груза
Указываются только те поля, которые нужно изменить
Ответ
Ошибка — 404.
В случае успеха — отстуствие ошибки.

Удаление, архивирование груза или транспорта

https://cmr24.by/api/cargo-delete
ЗАПРОС GET
Удаление, архивирование груза или транспорта
Ответ
Ошибка — 404.
В случае успеха — отстуствие ошибки.

Восстановление заявки из архива

https://cmr24.by/api/cargo-restore
ЗАПРОС GET
Восстановление заявки из архива
Ответ
Ошибка — 404.
В случае успеха — отстуствие ошибки.