Сервис ЭДиН: База знаний
 
   
Начало / Интеграция, API / Использование API для получения xml документа BLRAPN с WEB платформы

Использование API для получения xml документа BLRAPN с WEB платформы

ID статьи: 184
Последнее обновление: 13 июн, 2024

Есть возможность использования API, который на запрос, включающий номер накладной и GLN организации, выдаст список ожидаемых платформой действий (actions). Далее по одному из этих действий можно отправить запрос на формирование xml с платформы. XML-документ подписывается с клиентской стороны и отправляется на платформу типовыми средствами.

  1. Адрес API в rest service: https://api-test.edn.by/webjars/swagger-ui/index.html?configUrl=/swagger.json/swagger-config#/
  2. API по получению actions: GET /actions

Запрос:

GET /actions?companyILN=4811562900006&waybillNumber=002-4811562900006-0166426654279150029485511 HTTP/1.1

Host: api-dev.edn.by

Authorization: Basic 123

Пример ответа:

  "actions": [

       "CREATE_WAYBILL_CANCELLATION"

   ]
  1. API для получения xml-документа для action: GET /actions/perform

Запрос:

GET /actions/perform?companyILN=4811562900006&waybillNumber=002-4811562900006-0166426654279150029485511&action=CREATE_WAYBILL_CANCELLATION HTTP/1.1

Host: api-dev.edn.by

Authorization: Basic 123

Перечисление параметров в запросах:

Параметр Описание
companyILN ILN компании пользователя, вызывающего api. Может быть получателем либо отправителем.
action  Действие (action), полученное при отправке запроса в первом пункте.
waybillNumber  Номер накладной, для которой необходимо сформировать xml из цепочки либо по которой нужно получить возможные actions.

Перечисление возможных actions (действий, которые можно выполнить с накладной):

Actions Кому доступно Описание
ACCEPT_ORIGINAL_WAYBILL_RECEIVING receiver (получатель) Подтвердить получение оригинальной накладной.
CREATE_WAYBILL_CONFIRMATION receiver (получатель) Отправить подтверждение/ответ по накладной.
ACCEPT_WAYBILL_CONFIRMATION_RECEIVING shipper (отправитель) Подтвердить получение подтверждения/ответа накладной.
CREATE_WAYBILL_CHANGE_REQUEST receiver (получатель) Создать запрос на корректировку накладной.
ACCEPT_WAYBILL_CHANGE_REQUEST_RECEIVING shipper (отправитель) Подтвердить запрос на корректировку накладной.
CREATE_WAYBILL_CANCELLATION shipper (отправитель) Отправить отмену по накладной.
ACCEPT_WAYBILL_CANCELLATION_RECEIVING receiver (получатель) Подтвердить запрос на отмену накладной.
PENDING  В ожидании. В данный момент, обрабатывается документ из цепочки, actions будут возвращены после обработки этого документа.
Эта статья была:   Полезна | Не полезна
Сообщить об ошибке
ID статьи: 184
Последнее обновление: 13 июн, 2024
Ревизия: 7
Просмотры: 727
Комментарии: 0
Пред.
След.
« Условия для стабильной работы интегрированного решения 1с с...
Описание релизов интеграционного модуля Docu1C »