Каталог Файлового шлюза API

Сценарий обработки пакетов

1. Получить Список пакетов (возвращает список ID)
2. Получить пакет (по ID)
3. Получить файл
4. Получить подпись
5. Отправить транзитный пакет
6. Получить статус
7. Отправить квитанцию по транзитному пакету*

Получение списка пакетов

GET /api/package?channel= &date=&id=&count=

Ресурс позволяет запросить в ФШ список пакетов по конкретному каналу.

Пример запроса

GET /api/package?channel=EVRAZREG/TT&date=2020-06-03&id=0&count=50 HTTP/1.1
Host: 188.227.17.120:8088

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

{
  "channel":"EVRAZREG/TT",
  "id":22423,
  "name":"W0369639.ZIP",
  "files":[{
    "id":30112,
    "name":"WINF.XML",
    "signs":[{
      "serial":"40:50:14:B0:2E:A0:BA:C0:C6:19:B8:87:5B:C4:80:73",
      "subject":"INN=007702165310,OGRN=1027739132563,SNILS=05555599999,T=Руководитель организации,CN=Петров Петр Петрович,OU=Правление,O=НКО АО НРД,L=Москва,ST=77 г.Москва,C=RU",
      "description":"OK",
      "status":"VALID"
    }]
  }]
},
{
  "channel":"EVRAZREG/TT",
  "id":22424,
  "name":"W0365245.ZIP",
  "files":[{
    "id":30113,
    "name":"WINF.XML",
    "signs":[{
      "serial":"40:50:14:B0:2E:A0:BA:C0:C6:19:B8:87:5B:C4:80:73",
      "subject":"INN=007702165310,OGRN=1027739132563,SNILS=05555599999,T=Руководитель организации,CN=Петров Петр Петрович,OU=Правление,O=НКО АО НРД,L=Москва,ST=77 г.Москва,C=RU",
      "description":"OK",
      "status":"VALID"
    }]
  }]
}

Модель ответа

Получение пакета

GET /api/package/:id

Ресурс позволяет по ID получить пакет из ФШ.

Пример запроса

GET /api/package/22423 HTTP/1.1
Host: 188.227.17.120:8088

Модель запроса

Пример ответа (спецсимволы)

���c�ܪv_6u\u0018i̠�\u001cf�삠�3�K3#\r�^�C��Ώ�(�����Ώ�(�����Ώ�(�����Ώ�(�����Ώ�(�����Ώ�`

Модель ответа

Получение файла

GET /api/package/file/:id?type=file

Ресурс позволяет по ID пакета получить связанный файл.

Пример запроса

GET /api/package/file/30112?type=file HTTP/1.1
Host: 188.227.17.120:8088

Модель запроса

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

<?xml version="1.0" encoding="Windows-1251"?>
<!DOCTYPE COVERING_LETTER>
<COVERING_LETTER PROCESSING_MODE="LIVE" STATE="NDC_TO_RECIP" TRANSIT="YES">
  <ORIGINATOR>
    <CONTRAGENT>
      <CONTRAGENT_CODE>EVRAZREG/TT</CONTRAGENT_CODE>
    </CONTRAGENT>
  </ORIGINATOR>
  <RECIPIENT>
    <CONTRAGENT>
      <CONTRAGENT_CODE>NDC0000000TT</CONTRAGENT_CODE>
    </CONTRAGENT>
  </RECIPIENT>
  <SERVICE_MARKS>
    <SUBJECT>TT.Payment</SUBJECT>
    <COMMENT>7746326164</COMMENT>
    <LETTER_ID>664bdeec-08cc-4ac8-836e-1ebb8f03a61e</LETTER_ID>
    <CONTR_LETTER_ID>W0360002</CONTR_LETTER_ID>
    <LETTER_TYPE>NDC0STND</LETTER_TYPE>
    <CONVERSATION_ID>76a3aa53-c228-4c9e-a932-88fc37d97313</CONVERSATION_ID>
    <CREATE_TIME>
      <DATETIME>
        <DATE>03.06.2020</DATE>
        <TIME>05:04:04</TIME>
      </DATETIME>
    </CREATE_TIME>
    <NDC_RECEPT_TIME>
      <DATETIME>
        <DATE>03.06.2020</DATE>
        <TIME>11:53:10</TIME>
      </DATETIME>
    </NDC_RECEPT_TIME>
    <NDC_LETTER_ID>2391352206</NDC_LETTER_ID>
    <ORIG_CONF_SEND_TIME>
      <DATETIME>
        <DATE>03.06.2020</DATE>
        <TIME>11:53:10</TIME>
      </DATETIME>
    </ORIG_CONF_SEND_TIME>
    <NDC_CHECKING><CHECKING RESULT="SUCCESS"/></NDC_CHECKING>
  </SERVICE_MARKS>
  <DOC CONTR_DOC_ID="20200360001" STORE_IN_NDC="YES" ENCRYPTED="YES" DELIVERY_TIMED_OUT="NO" TRANSFER_AGENT_CONTRACT="NO">
    <FILE_NAME>W0360001</FILE_NAME>
    <DOC_TYPE>TRZT</DOC_TYPE>
    <ORIGINAL_FILE_NAME>03f8e57d-f9c1-46a1-a41c-3b91a5ca03fa.json</ORIGINAL_FILE_NAME>
    <NDC_STORAGE_DOC_ID>2391352179</NDC_STORAGE_DOC_ID>
    <NDC_CHECKING><CHECKING RESULT="SUCCESS"/></NDC_CHECKING>
  </DOC>
</COVERING_LETTER>

Модель ответа

Источник: «Руководство пользователя ПО «Файловый шлюз ЭДО НРД». Приложение 1. Инструкция по обмену электронными документами»

Схема транзитного конверта и квитанций:

Примечание: необязательные поля, заполнение которых не требуется, в таблице отсутствуют.

Получение подписи

GET /api/package/file/:id?type=sign

Ресурс позволяет по ID получить подпись файла.

Пример запроса

GET /api/package/file/30112?type=sign HTTP/1.1
Host: 188.227.17.120:8088

Модель запроса

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

Получить образец

Отправка транзитного пакета

POST /api/transit/:channel

Ресурс позволяет отправить транзитный пакет получателю, содержащий файл:

• pain.002
• camt.053
• сamt.052
• пр.

Параметром указывается собственный депозитарный код;

В Body помещается:

• Файл для отправки;
• Информация transitinfo.

Пример запроса

POST /api/transit/EVRAZREGTT HTTP/1.1
Host: 188.227.17.120:8088
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="/C:/Users/777/Desktop/123.txt"
Content-Type: text/plain

(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="transitInfo"

{
    "Contragent": "MC0003300000",
    "Subject": "Subject",
    "Comment": "Comment",
    "LetterId": "0616292B-1225-4350-8847-BF1BEB68CDE3",
    "ConversationId": "03B4FC61-76A5-4773-9822-BAF17412A6FC",
    "CreateDate": "2020-06-03T10:00:00",
    "CreateTime": "2020-06-03T10:00:00",
    "docInfo": [
        {
            "encrypted": "true",
            "transferAgentContract": "false",
            "fileName": "123.txt",
            "docType": "TRZT"
        }
    ]
}
----WebKitFormBoundary7MA4YWxkTrZu0gW

Модель запроса

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

7515

Модель ответа

Запрос статуса

GET /api/package/:id

Ресурс позволяет по ID получить пакет из ФШ.

Пример запроса

GET /api/package/status/7515 HTTP/1.1
Host: 188.227.17.120:8088

Модель запроса

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

{"id":7515,"name":"W0360002.ZIP","status":"SENT","error":null}

Модель ответа

«Ручная» отправка транзитных квитанций

В настройках канала WSL ФШ по умолчанию предусмотрена опция «Автоотправка уведомлений». Если Банк (по разным причинам) желает самостоятельно формировать квитанции, то следует использовать метод «Отправка транзитных квитанций».

Ресурс позволяет по ID полученного пакета направить ответную квитанцию..

Пример запроса

POST /api/transit/184/sendReceipt HTTP/1.1
Host: 188.227.17.120:8088
Content-Type: text/plain

Модель запроса

Пример ответа (спецсимволы)

Модель ответа

Приложения

Дополнительные материалы

Схема движения документа по статусам

Для информирования пользователя о состоянии документа в Терминале Транзита 2.0 (далее ТТ) используются транспортные статусы. Независимо от типа и формата все документы в ТТ движутся по схожей схеме транспортных статусов.

Графическое представление схемы движения документа по статусам отображено на рисунках ниже:

• Общая схема движения документа по статусам (см. Рисунок 4).
• Схема движения документа по статусам в ТТ (см. Рисунок 1).
• Схема движения документа по статусам в ФШ Клиента, ЭДО НРД, ФШ Банка (см. Рисунок 2).
• Схема движения документа по статусам в Банке (см. Рисунок 3).

Расшифровка элементов схемы описана в Таблице 1.

Подробное описание схемы движения документа по статусам описано в Таблице 2, Таблице 3 и в Таблице 4.

Таблица 1 - Расшифровка элементов схемы

Схематичное изображение	Описание
	Блок - сущность, в которой происходит смена статусов
	Начало, входные данные
	Документ со статусом
	Процесс
	Промежуточное местонахождение документа
	Прямая связь
	Опциональная связь
	Все документы в статусах блока могут перейти в данный статус

Движение документа по статусам в Транзит 2.0

Рисунок 1 - Схема движения документа по статусам в Транзит 2.0

Таблица 2 - Расшифровка статусов

Движение документа по статусам в Файловом шлюзе Клиента, в ЭДО НРД и в Файловом шлюзе Банка

Рисунок 2 - Схема движения документа по статусам в ФШ Клиента, в ЭДО НРД и в ФШ Банка

Таблица 3 - Расшифровка статусов

Движение документа по статусам в Банке

Рисунок 3 - Схема движения документа по статусам в Банке

Таблица 4 - Расшифровка статусов

Общая схема движения документа по статусам

Рисунок 4 - Общая статусная модель