Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 10 Следующий »

Кратко о данном разделе

Цель данного раздела - рассказать, как использовать API  с точки зрения функций платформы.

Это позволит понять, какие методы, в какой последовательности использовать.

Функциональная карта Перевозчика

Авторизация

Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.

  1. Получить токен - используйте метод </auth/token GET>. 

Участие в торгах

Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.

Ограничения: 

  • Доступные типы торга - Кто быстрее, Аукцион
  • Объект торга - Разовая заявка

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

  1. Получить перечень разовых заявок в торге - используйте метод </request_view GET>. 
    1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Бронировать заявку с типом торга Кто Быстрее - используйте метод </shipping_requests/{shipping_request_id}/reserve POST>.
      2. Принять участие в торге по заявке с типом торга Аукцион (используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
        1. Получить перечень торгов, с активной ставкой - используйте метод </shipping_requests/{shipping_request_id}/bids GET>
          1. Отменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids/{bid_id}/archive PUT>
          2. Изменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
  2. Получить перечень заявок, по которым торг завершён успешно - используйте метод </shippings GET>.
  3. Получить заявку по ID  - используйте метод </request_view/{id} GET>


Назначение ресурсов

Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

  1. Получить перечень заявок в статусе На оформлении используйте метод </shippings GET> status = "resources_waiting"
    1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Получить перечень подходящих Водителейиспользуйте метод </resources/drivers&suitable_for_shipping=UUID GET>
      2. Получить перечень подходящих ТС - используйте метод </resources/cars&suitable_for_shipping=UUID GET>
      3. Получить перечень подходящих Прицеповиспользуйте метод </resources/trailers&suitable_for_shipping=UUID GET>
      4. Назначить ресурсы на заявку - используйте метод </shippings/{shipping_id}/assign_resources POST>


Функциональная карта Грузовладельца

Авторизация

Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.

  1. Получить токен - используйте метод </auth/token GET>. 

Работа с партнёрами

Ниже представлен сокращённый перечень методов по работе с партнёрами.

Ограничения: 

  • Отправка запросов и отзыв запросов - в ЛК
  • Настройка групп (создание, редактирование, удаление) - в ЛК
  • Управление ЧС - в ЛК 

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

  1. Получить список партнёров - используйте метод <...>.  
    1. Если в ответ получен непустой список, то по каждому партнёру можно отдельно получить всю информацию:
      1. Получить информацию по конкретному партнёру используйте метод <...>
  2. Получить список групп партнёров тип торга Кто быстрее - используйте метод <...>. 
    1. в ответ получен непустой список, то по каждому партнёру можно отдельно получить всю информацию:
      1. Получить информацию по конкретному партнёру используйте метод <...>

Создание заявки

Ниже представлен сокращённый перечень методов, необходимых для публикации заявки в торгах.

Ограничения: 

  • Доступные типы торга - Кто быстрее, Аукцион (3 типа)
  • Объект торга - Разовая заявка
  • Создание черновиков - 

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

  1. Создать заявку - используйте метод <...>.  
    1. Настройка типа торга 
      1. тип торга Кто быстрее - используйте метод <...>. 
      2. тип торга Аукцион (Открытый) - используйте метод <...>. 
      3. тип торга Аукцион (Закрытый) - используйте метод <...>. 
      4. тип торга Аукцион (На понижение) - используйте метод <...>. 
    2. Настройка получателей -
      1. Публикация Все исполнители - используйте метод <...>
      2. Публикация Все партнёры - используйте метод <...>
      3. Публикация Выбранные партнёры- используйте метод <...>

Работа с заявкой

Ниже представлен сокращённый перечень методов, необходимых для работы с заявкой после торга.

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

  1. Получить перечень заявок в статусе В торге используйте метод <...>
    1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Получить информацию по конкретной заявке используйте метод <...>
  2. Получить перечень заявок в статусе На исполнении используйте  <...>
    1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Получить информацию по конкретной заявке используйте метод <...>
  3. Утверждение заявкииспользуйте метод <...>
    1. На данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
      1. Данные о Грузоотправителе (данные о компании и контактное лицо)
      2. Данные о Грузополучателе (данные о компании и контактное лицо)
      3. Точные адреса по точкам
  4. Подписание заявки ПЭП используйте метод <...>
  5. Подтверждение выполненияиспользуйте метод <...>
  6. Отмена заявкииспользуйте метод <...>
  7. Получить перечень заявок в статусе В архиве используйте метод <...>
    1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Получить информацию по конкретной заявке используйте метод <...>



  • Нет меток