Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

В этой статье мы создадим запрос от имени грузовладельца с минимальным набором параметров и проверим статус торгов. Для этого мы будем использовать тестовую среду и интерактивную «песочницу» в качестве инструмента формирования запросов к API.

  1. Зайти в песочницу тестовой среды https://testdev2.logistpro.su/api/docs/ui/index
  2. Ввести и применить ключ (API Key) для компании-грузовладельца (из статьи Тестовая среда testdev2)

    Для ТрансДемо1 значение ключа: jn/PYDwYKV7INbTQwZFdpXe4LEuYvBg9fgsIdykDigM=
  3. Авторизоваться в методе POST /api/v1/account/login от имени пользователя ext.customer.1@logistpro.su

  4. Получить необходимую справочную информацию для создания запроса в методе GET /api/v1/tender/create

    В минимальном виде, нам нужны два идентификатора:
    • Юридическое лицо: 4af53a58-45e2-4b78-ba50-25299a5978be (заказчик перевозки)
    • Ответственный сотрудник: 2e912068-48ba-49df-9656-48583f5b2939 (данный сотрудник будет получать уведомления о ходе торгов на email и его контакты будут показываться участникам торгов для уточнения информации)
  5. Вызвать метод создания запроса POST /api/v1/tender/create

    передав структуры данных с минимально необходимым набором параметров:

    {
        "Cargo": "Продукты питания",
        "CargoWeight": 3.5,
        "CargoVolume": 4.25,
        "Tender": {
            "VatReqs": "None"
        },
        "TransportRequirements": {
            "TransportType": "Auto"
        },
        "PackageDetails": [
            {
                "Type": "Pallets",
                "Number": 33
            }
        ],
        "RoutePoints": [
            {
                "Type": "Loading",
                "Address": "Москва, улица Ленина д.1",
                "ArrivalTime": "2022-03-11T00:00:00.000",
                "LeaveTime": "2022-03-12T00:00:00.000"
            },
            {
                "Type": "Unloading",
                "Address": "Санкт-Петербург, улица Ленина д.1",
                "ArrivalTime": "2022-03-15T00:00:00.000",
                "LeaveTime": "2022-03-16T00:00:00.000"
            }
        ],
        "Customer": {
            "CompanyId": "4af53a58-45e2-4b78-ba50-25299a5978be",
            "ContactId": "2e912068-48ba-49df-9656-48583f5b2939"
        }
    }

    В данной структуре передаются:

    • данные груза: поля Cargo, CargoWeight, CargoVolume
    • требования к участникам торгов: Tender.VatReqs=None - нет специальных требований в оплате НДС исполнителем
    • требования к транспорту: TransportRequirements.TransportType=Auto - автотранспорт
    • описание упаковки груза: PackageDetails
    • точки маршрута: RoutePoints - одна точка погрузки и одна точка выгрузки и время прибытия на эти точки
    • данные заказчика: Customer - идентификаторы, полученные в прошлом пункте
  6. Более подробная информация по передаваемым параметрам и требованиям к ним, отображена в Описании к модели данным:
  7. В результате работы метода создания, получаем код ответа 200 и идентификатор нового запроса:
  8. Новый запрос можно проверить:
    1. в интерфейсе

      подставив в url адрес https://testdev2.logistpro.su/Tender/Details/<id> полученный идентификатор запроса
    2. через API

      вызвав метод GET /api/v1/tender/{id}, подставив полученный идентификатор запроса в поле id
      В полученном ответе, будут все необходимые данные запроса, включая текущий статус торгов, полученные предложения и т.п.
  • No labels