Включить выборку | ||||||
---|---|---|---|---|---|---|
|
Оглавление |
---|
Подсказка | ||||
---|---|---|---|---|
| ||||
Цель данного раздела - рассказать, как использовать API с точки зрения функций платформы. Это позволит понять, какие методы, в какой последовательности использовать. |
Функциональная карта Перевозчика
Авторизация
Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.
- Получить токен - используйте метод </auth/token GETPOST>.
Участие в торгах
Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.
Ограничения:
- Доступные типы торга - Кто быстрее, Аукцион
- Объект торга - Разовая заявка
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень разовых заявок в торге - используйте метод </request_view GET>.
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Бронировать заявку с типом торга Кто Быстрее - используйте метод </shipping_requests/{shipping_request_id}/reserve POST>.
- Принять участие в торге по заявке с типом торга Аукцион (используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
- Получить перечень торгов, с активной ставкой - используйте метод </shipping_requests/{shipping_request_id}/bids GET>
- Отменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids/{bid_id}/archive PUT>
- Изменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
- Получить перечень торгов, с активной ставкой - используйте метод </shipping_requests/{shipping_request_id}/bids GET>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень заявок, по которым торг завершён успешно - используйте метод </shippings GET>.
- Получить заявку по ID - используйте метод </request_view/{id} GET>
Назначение ресурсов
Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень заявок в статусе На оформлении используйте метод </shippings GET> status = "resources_waiting"
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень подходящих Водителей- используйте метод </resources/drivers&suitable_for_shipping=UUID GET>
- Получить перечень подходящих ТС - используйте метод </resources/cars&suitable_for_shipping=UUID GET>
- Получить перечень подходящих Прицепов- используйте метод </resources/trailers&suitable_for_shipping=UUID GET>
- Назначить ресурсы на заявку - используйте метод </shippings/{shipping_id}/assign_resources POST>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
Функциональная карта Грузовладельца
Авторизация
Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.
- Получить токен - используйте метод </auth/token GETPOST>.
Работа с партнёрами
Ниже представлен сокращённый перечень методов по работе с партнёрами.
Ограничения:
- Отправка запросов и отзыв запросов - в ЛК
- Настройка групп (создание, редактирование, удаление) - в ЛК
- Управление ЧС - в ЛК
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить список партнёров - используйте метод <...partnerships GET>.
- Если в ответ получен непустой список, то по каждому партнёру можно отдельно получить всю информацию:
- Получить информацию по конкретному партнёру - используйте метод <...>метод <partnerships GET>, в параметре q указать Человекочитаемый ID партнёра, название компании партнёра или ИНН партнёра
- Если в ответ получен непустой список, то по каждому партнёру можно отдельно получить всю информацию:
- Получить список групп партнёров тип торга Кто быстрее - используйте метод <...<partnerships/groups GET>.
- <partnerships/groups GET>, в параметре q указать Человекочитаемый ID партнёра, название компании партнёра или ИНН партнёра
Создание Заказа
Ниже представлен сокращённый перечень методов, необходимых для публикации заявки в торгах.
Ограничения:
- Доступные типы торга - Кто быстрее, Аукцион (3 типа)
- Объект торга - Разовая заявка
- Создание черновиков - не доступно
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Создать заявку Заказ - используйте метод <...<shipping_orders GET>.
- Настройка этапов торга:
- в параметре auction_stages требуется передать массив из этапов торгов
- Настройка типа торга
- тип торга Кто быстрее - используйте метод <...>. в параметре auction_stages, в переданном значении этапа торга указать в параметре auction_type значение "instant_reservation"
- тип торга Аукцион (Открытый)- используйте метод <...>. в параметре auction_stages, в переданном значении этапа торга указать в параметре auction_type значение "auction"
- тип торга Аукцион (Закрытый) - используйте метод <...>. - в параметре auction_stages, в переданном значении этапа торга указать в параметре auction_type значение "blind_auction"
- тип торга Аукцион (На понижение) - используйте метод <...>. - в параметре auction_stages, в переданном значении этапа торга указать в параметре auction_type значение "descending_price_auction"
- Для аукционов - в параметре auction_stages, в переданном значении этапа торга указать в параметре winner_selection_type значение "automatically" (значение по умолчанию)
- Настройка получателей -
- Публикация Все исполнители - используйте метод <...> - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "all"
- Публикация Все партнёры - используйте метод <...>в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "partners"
- Публикация Выбранные партнёры- используйте метод <...>
- Настройка этапов торга:
- партнёры - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "exclusive",
- Перечисление Партнёров: в параметре companies_ids в массиве передать список из ID компаний, среди которых будет виден заказ
- Перечисление Групп Партнёров: в параметре groups_ids в массиве передать список из ID групп, среди которых будет виден заказ
- партнёры - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "exclusive",
Работа с Заказом
Ниже представлен сокращённый перечень методов, необходимых для работы с заявкой после торга.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень заявокЗаказов в статусе В торге - используйте метод <...> <shipping_orders GET> в параметре status передать значение "in_auction"
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить информацию по конкретной заявке - используйте метод <...>shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр shipping_order_id - uuid Заказа
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень заявок в статусе На исполнении используйте <...>спользуйте метод <shipping_orders GET> в параметре status передать значение "in_trip" (в Пути) или "trip_waiting" (Предстоящая перевозка)
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить информацию по конкретной заявке - используйте метод <...>shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр shipping_order_id - uuid Заказа
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Утверждение заявки - используйте метод <...>
- На данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
- Данные о Грузоотправителе (данные о компании и контактное лицо)
- Данные о Грузополучателе (данные о компании и контактное лицо)
- Точные адреса по точкам
- На данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
- Подписание заявки ПЭП - используйте метод <...> происходит автоматически при утверждении заявки
- Подтверждение выполнения - используйте метод <...>/shipping_orders/{shipping_order_id}/accept_shipping POST>
- В запросе необходимо передавать параметр shipping_order_id - uuid Заказа
- Отмена заявки - используйте метод <...метод <cancel POST>
- Получить перечень заявок в статусе В архиве - используйте метод <...> <shipping_orders GET> в параметре status передать значение "in_auction"
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить информацию по конкретной заявке - используйте метод <...>shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр shipping_order_id - uuid Заказа
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
UI Button | ||||||
---|---|---|---|---|---|---|
|
Остались вопросы?
- Посмотри раздел
UI Button color green icon question title Вопросы и ответы url http://wiki.traffic.online/pages/viewpage.action?pageId=327718 - Позвони 8(800)707-007-1
- Напиши вопрос на info@traffic.online
- Сообщи о проблеме на support@traffic.online
Livesearch | ||||
---|---|---|---|---|
|