Беларусь

region-img

Документация Сотбит: REST API. Роутинг

Роутинг

В модуле доступен следующий перечень роутов:

перечень доступных роутов можно получить по роуту {router_dir}/v1
Роут Тип запроса Описание
/v1/auth POST Реализует авторизацию пользователя.
Обязательные поля:
  • login
  • password
/v1/auth/forgot POST Реализует отправку письма для восстановления пароля.
Обязательные поля:
  • email
/v1/users GET Возвращает список пользователей
/v1/orders GET Возвращает список заказов пользователя Не обязательное поле:
  • filter - параметр фильтрации получаемого списка
/v1/orders/{id} GET Возвращает информацию по заказу
  • id - Идентификатор заказа
/v1/orders/status/{id} GET Возвращает статус заказа
  • id - Идентификатор заказа
/v1/orders/statuses GET Возвращает список статусов заказа
/v1/orders/cancel POST Отменяет заказ
Обязательное поля:
  • id - идентификатор заказа
Не обязательное поле:
  • reason - причина отмены заказа
/v1/orders/deliveries GET Возвращает список служб доставки
/v1/orders/paysystem GET Возвращает список служб оплаты
/v1/orders/persontypes GET Возвращает список типов плательщика
/v1/support GET Возвращает параметры службы технической поддержки
/v1/support/tickets POST Создает обращений в службу технической поддержки
Обязательное поля:
  • title - заголовок обращения
  • message - текст обращения
Не обязательное поле:
  • files - прикрепленные файлы
  • category - категория обращения
  • criticality - критичность обращения
  • mark - пометка обращения
/v1/support/messages/ticket/{id} POST Создает новое сообщение в обращении
  • id - идентификатор обращения
Обязательное поля:
  • message - текст обращения
Не обязательное поле:
  • files - прикрепленные файлы
  • criticality - критичность обращения
  • mark - пометка обращения
/v1/support/tickets/close POST Закрывает обращение
Обязательное поля:
  • id - идентификатор обращения
/v1/support/tickets/open POST Открывает обращение
Обязательное поля:
  • id - идентификатор обращения
/v1/support/tickets GET Возвращает список обращений пользователя по фильтру Не обязательное поле:
  • filter - параметр фильтрации получаемого списка
/v1/support/tickets/{id} GET Возвращает обращение в службу технической поддержки
  • id - идентификатор обращения
/v1/support/messages/ticket/{id} GET Возвращает список сообщений обращения в службу технической поддержки
  • id - идентификатор обращения
Не обязательное поле:
  • filter - параметр фильтрации получаемого списка
/v1/support/messages/{id} GET Возвращает сообщение в службу технической поддержки
  • id - идентификатор сообщения
/v1/support/file/{hash} GET Возвращает прикрепленный к сообщению файл
  • hash - Хэш ключ файла