Включить выборку | ||||||
---|---|---|---|---|---|---|
|
Оглавление |
---|
Подсказка | ||||
---|---|---|---|---|
| ||||
Цель данного раздела - рассказать, как использовать API с точки зрения функций платформы. Это позволит понять, какие методы, в какой последовательности использовать. |
Функциональная карта Перевозчика
title | Управление партнёрскими отношениями |
---|
Авторизация
Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.
- Получить токен - используйте метод </auth/token POST>.
Пример просмотра ссылки на метод (обращение к боевой API)
Создание ресурсов
Ниже представлен сокращённый перечень методов, необходимых для подготовки ресурсов на выполнение перевозок.
Ограничения:
- Грузовладельцы самостоятельно определяют порядок проверки ресурсов.
- По заявкам ДЛ и ГетКарго для проверки обязательно прикрепление документов в карточке ресурса.
- Прикрепление документов в карточку ресурса возможно только после того, как ресурс создан.
- Файлы, которые крепятся к ресурсам загружаются в контейнер, который называется документ.
- Для каждого типа ресурса определён свой перечень документов.
- Для того чтобы прикрепить файл в карточку ресурса требуется создать документ.
- Для обновления файлов, прикреплённых к карточке ресурса, требуется удалять файлы в документе карточки ресурса и загружать новые файлы
- .
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень запросов на установление партнёрских отношений - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Принять запрос на партнёрство - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Отклонить запрос на партнёрство - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Получить перечень действующих партнёров
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Прекратить партнёрские отношения с компанией - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Направить компанию в чёрный список - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Получить перечень компаний в Чёрном списке:
- Если в ответ получен непустой список:
- Исключить компанию из чёрного списка - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список:
title | Участие в торгах |
---|
Участие в торгах зависит от нескольких условий:
- Тип торга - Кто быстрее, Аукцион
- Объект торга - График, Разовая заявка
- Участник торга - Персональное предложение, Общий торг
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень разовых заявок в торге - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Предложить изменения по заявке в торге - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Бронировать заявку с типом торга Кто Быстрее - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Принять участие в торге по заявке с типом торга Аукцион (используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Получить перечень торгов, с активной ставкой - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Отменить ставку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Изменить ставку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Получить перечень торгов, с активной ставкой - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень графиков в торге - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Проставить ставку по графику - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Получить перечень графиков, с активной ставкой - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Отменить ставку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Изменить ставку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Получить перечень графиков, с активной ставкой - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Проставить ставку по графику - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень персональных предложений - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Принять условия персонального предложения (используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Отклонить условия персонального предложения (используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить перечень заявок, по которым торг завершён успешно (используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
title | Управление ресурсами |
---|
- Создать карточку ресурса - используйте метод
- Карточка Водителя: </resources/{company_id}/drivers POST>.
- company_id - uuid компании Перевозчика
- Карточка ТС: </resources/{company_id}/cars POST>.
- company_id - uuid компании Перевозчика
- Карточка Прицепа: </resources/{company_id}/trailers POST>.
- company_id - uuid компании Перевозчика
- Карточка Водителя: </resources/{company_id}/drivers POST>.
- Получение перечня документов для карточки ресурса- используйте метод:
- Для Водителя: </resources/{company_id}/drivers/{driver_id}/document_types GET>.
- company_id - uuid компании Перевозчика
- driver_id - uuid Водителя
- Для ТС: </resources/{company_id}/cars/{car_id}/document_types GET>.
- company_id - uuid компании Перевозчика
- car_id - uuid ТС
- Для Прицепа: </resources/{company_id}/trailers/{trailer_id}/document_types GET>.
- company_id - uuid компании Перевозчика
- trailer_id - uuid Прицепа
- Для Водителя: </resources/{company_id}/drivers/{driver_id}/document_types GET>.
- Создание документа в карточке ресурса (для последующего прикрепления файла)- используйте метод:
- для Водителя: </resources/{company_id}/drivers/{driver_id}/documents POST>.
- company_id - uuid компании Перевозчика
- driver_id - uuid Водителя
- Для ТС: </resources/{company_id}/cars/{car_id}/documents POST>.
- company_id - uuid компании Перевозчика
- car_id - uuid ТС
- Для Прицепа: </resources/{company_id}/trailers/{trailer_id}/documents POST>.
- company_id - uuid компании Перевозчика
- trailer_id - uuid Прицепа
- для Водителя: </resources/{company_id}/drivers/{driver_id}/documents POST>.
- Загрузка файла в документ, по карточке ресурса (для последующего прикрепления файла)- используйте метод:
- для Водителя: </resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file POST>.
- company_id - uuid компании Перевозчика
- driver_id - uuid Водителя
- document_id - uuid документа по которому загружается файл
- Для ТС: </resources/{company_id}/cars/{car_id}/documents/{document_id}/file POST>.
- company_id - uuid компании Перевозчика
- car_id - uuid ТС
- document_id - uuid документа по которому загружается файл
- Для Прицепа: </resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file POST>.
- company_id - uuid компании Перевозчика
- trailer_id - uuid Прицепа
- document_id - uuid документа по которому загружается файл
- для Водителя: </resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file POST>.
- Получить перечень ресурсов - используйте метод
- Список Водителей: </resources/{company_id}/drivers GET>.
- company_id - uuid компании Перевозчика
- Список ТС: </resources/{company_id}/cars GET>.
- company_id - uuid компании Перевозчика
- Список Прицепов: </resources/{company_id}/trailers GET>.
- company_id - uuid компании Перевозчика
- Список Водителей: </resources/{company_id}/drivers GET>.
- Получить данные конкретного ресурса - используйте метод
- Получить Водителя: </resources/{company_id}/drivers/{driver_id} GET>.
- company_id - uuid компании Перевозчика
- driver_id - uuid Водителя
- Получить ТС: </resources/{company_id}/cars/{car_id} GET>.
- company_id - uuid компании Перевозчика
- car_id - uuid ТС
- Получить Прицеп: </resources/{company_id}/trailers/{trailer_id} GET>.
- company_id - uuid компании Перевозчика
- trailer_id - uuid Прицепа
- Получить Водителя: </resources/{company_id}/drivers/{driver_id} GET>.
- Внести изменения в карточку ресурса - используйте метод
- Получить Водителя: </resources/{company_id}/drivers/{driver_id} PUT>.
- company_id - uuid компании Перевозчика
- driver_id - uuid Водителя
- Получить ТС: </resources/{company_id}/cars/{car_id} PUT>.
- company_id - uuid компании Перевозчика
- car_id - uuid ТС
- Получить Прицеп: </resources/{company_id}/trailers/{trailer_id} PUT>.
- company_id - uuid компании Перевозчика
- trailer_id - uuid Прицепа
- Получить Водителя: </resources/{company_id}/drivers/{driver_id} PUT>.
Участие в торгах
Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.
Ограничения:
- Доступные типы торга - Кто быстрее, Аукцион
- Объект торга - Разовая заявка
Управление ресурсами включает в себя несколько различных методов.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень
- разовых заявок в торге - используйте метод </request_view GET>.
- Если в ответ получен непустой список, то по
- Редактировать (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Удалить (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Направить на проверку (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Если в ответ получен непустой список, то по каждому ресурсу доступны решения:
- Редактировать (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Удалить (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Направить на проверку (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Если в ответ получен непустой список, то по каждому ресурсу доступны решения:
- Редактировать (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Удалить (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Направить на проверку (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- каждой заявке требуется принятия решения:
- Бронировать заявку с типом торга Кто Быстрее - используйте метод </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>
Назначение ресурсов
Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.
- Водитель - (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- ТС - (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
- Прицеп - (используйте метод <тут могла быть ваша реклама или ссылка на метод API>)
title | Управление заявками |
---|
Управление заявками зависит от статуса заявки:
Статус subtle true colour Green title На оформлении Статус subtle true colour Red title Предстоящие Статус subtle true colour Blue title Выполняются Статус subtle true title Завершённые
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
>- Получить перечень заявок в статусе На оформлении используйте метод <
- /shippings GET> status = "resources_waiting"
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения
- - какие ресурсы назначить.
- Получить ресурсы для назначения
- Получить перечень подходящих Водителей
- - используйте метод <
- /resources/drivers&suitable_for_shipping=UUID GET>
- Получить перечень подходящих ТС
- - используйте метод <
- /resources/cars&suitable_for_shipping=UUID GET>
- Получить перечень подходящих Прицепов
- - используйте метод <
- Назначить ресурсы на заявку - используйте метод <
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Переназначить ресурсы - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Отказаться от выполнения заявки - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Оформить страховку на заявку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Скачать Печатную Форму Заявки - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
- Подписать заявку - используйте метод <тут могла быть ваша реклама или ссылка на метод API>
Функциональная карта Грузовладельца
Авторизация
Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.
- Получить токен - используйте метод </auth/token POST>.
Пример просмотра ссылки на метод (обращение к боевой API)
Работа с партнёрами
Ниже представлен сокращённый перечень методов по работе с партнёрами.
Ограничения:
- Отправка запросов и отзыв запросов - в ЛК
- Настройка групп (создание, редактирование, удаление) - в ЛК
- Управление ЧС - в ЛК
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить список партнёров - используйте метод <partnerships GET>.
- Если в ответ получен непустой список, то по
- каждому партнёру можно отдельно получить всю информацию:
- Получить информацию по конкретному партнёру
- каждому партнёру можно отдельно получить всю информацию:
- - используйте
- метод <partnerships GET>, в параметре q указать Человекочитаемый ID партнёра, название компании партнёра или ИНН партнёра
- Получить список групп партнёров - используйте метод <partnerships/groups GET>.
- в ответ получен непустой список, то по каждой
- группе партнёров можно отдельно получить всю информацию:
- Получить информацию по конкретной группе партнёров
- - используйте метод
title | Управление страхованием |
---|
- <partnerships/groups GET>, в параметре q указать Человекочитаемый ID группы
Создание Заказа
Ниже представлен сокращённый перечень методов, необходимых для публикации заявки в торгах.
Ограничения:
- Доступные типы торга - Кто быстрее, Аукцион (3 типа)
- Объект торга - Разовая заявка
- Создание черновиков - не доступно
Предупреждение | ||
---|---|---|
| ||
Для создания заказа (либо на стадии утверждения) потребуется передавать данные об адресах маршрута. Для указания маршрута требуется передавать актуальный код ФИАС каждого из ваших адресов. ФИАС ID самого нижнего адресного объекта с точностью до улицы |
Управление страхованием включает в себя несколько различных методов.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
Оформить страховкуСоздать Заказ -
используйте метод
Функциональная карта Грузовладельца
title | Управление партнёрскими отношениями |
---|
Управление партнёрскими отношениями включает в себя несколько различных методов.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
- Получить перечень запросов на установление партнёрских отношений - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Принять запрос на партнёрство - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Отклонить запрос на партнёрство - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Получить перечень действующих партнёров
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Прекратить партнёрские отношения с компанией - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Направить компанию в чёрный список - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список, то по каждому запросу требуется принятия решения:
- Получить перечень компаний в Чёрном списке:
- Если в ответ получен непустой список:
- Исключить компанию из чёрного списка - используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
- Если в ответ получен непустой список:
title | Управление заявками |
---|
Управление заявками включает в себя несколько различных методов.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:
Настройка этапов торга:
в параметре 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" (значение по умолчанию)
Настройка получателей -
Используйте ОПФ из списка:
Подсказка title ОПФ {"id":1,"code":"12300","name":"ООО"},
{"id":2,"code":"12267","name":"ЗАО"},
{"id":3,"code":"12247","name":"ПАО"},
{"id":4,"code":"50102","name":"ИП"},
{"id":5,"code":"12200","name":"АО"}
Публикация Все исполнители - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "all"
Публикация Все партнёры - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "partners"
Публикация Выбранные партнёры - в параметре auction_stages, в переданном значении этапа торга указать в параметре visibility значение "exclusive",
Перечисление Партнёров: в параметре companies_ids в массиве передать список из ID компаний, среди которых будет виден заказ
Перечисление Групп Партнёров: в параметре groups_ids в массиве передать список из ID групп, среди которых будет виден заказ
- Заполнение данных Отправителя/Получателя в точке маршрута
- ЮЛ (в т.ч. ИП), в блоке route_points (массив точек маршрута), для каждой точки требуется:
- Передать значение параметра contact_company_title
- Передать значение параметра contact_inn
- Передать значение параметра contact_kpp
- Передать значение параметра contact_opf_code
- Передать значение параметра contact_opf_name
- в параметре contacts требуется передать массив контактных лиц:
- значение параметра full_name
- значение параметра phone
- ФЛ, в блоке route_points (массив точек маршрута), для каждой точки требуется:
- в параметре contacts требуется передать массив контактных лиц:
- значение параметра full_name
- значение параметра phone
- значение параметра passport_number
- значение параметра passport_issued_at
- значение параметра passport_who_issued
- в параметре contacts требуется передать массив контактных лиц:
- ЮЛ (в т.ч. ИП), в блоке route_points (массив точек маршрута), для каждой точки требуется:
Работа с Заказом
Ниже представлен сокращённый перечень методов, необходимых для работы с заявкой после торга.Общая функциональность
title | Авторизация |
---|
Для того, чтобы приступить к работе на платформе необходимо авторизоваться.
Для этого используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
title | Управление профилем компании |
---|
Для того, чтобы _ необходимо _.
Для этого используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
title | Управление данными контактного лица |
---|
Для того, чтобы _ необходимо _.
Для этого используйте метод <тут могла быть ваша реклама или ссылка на метод API>.
title | Претензионный блок |
---|
Управление претензионным блоком использует несколько различных методов.
Рассмотрим последовательность действий и то, какие методы должны быть использованы:- Получить перечень
- Заказов в статусе В торге - используйте метод
- <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>
- На данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
- Точные адреса по точкам, в блоке route_points (массив точек маршрута)
- Данные о Грузоотправителе/Грузополучателе (данные о компании и контактное лицо)
- ЮЛ (в т.ч. ИП), в блоке route_points (массив точек маршрута), для каждой точки требуется:
- Передать значение параметра contact_company_title
- Передать значение параметра contact_inn
- Передать значение параметра contact_kpp
- Передать значение параметра contact_opf_code
- Передать значение параметра contact_opf_name
- в параметре contacts требуется передать массив контактных лиц:
- значение параметра full_name
- значение параметра phone
- ФЛ, в блоке route_points (массив точек маршрута), для каждой точки требуется:
- в параметре contacts требуется передать массив контактных лиц:
- значение параметра full_name
- значение параметра phone
- значение параметра passport_number
- значение параметра passport_issued_at
- значение параметра passport_who_issued
- в параметре contacts требуется передать массив контактных лиц:
- ЮЛ (в т.ч. ИП), в блоке route_points (массив точек маршрута), для каждой точки требуется:
- На данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
- Подписание заявки ПЭП - происходит автоматически при утверждении заявки
- Подтверждение выполнения - используйте метод <shippings/{shipping_id}/done POST>
- В запросе необходимо передавать параметр shipping_order_id - uuid Заказа
- Отмена заявки - используйте метод <cancel POST>
- Получить перечень заявок в статусе В архиве - используйте метод <shipping_orders GET> в параметре status передать значение ['completed', 'canceled_by_cargo_owning_company','canceled_by_transport_company']
- Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
- Получить информацию по конкретной заявке - используйте метод <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 | ||||
---|---|---|---|---|
|