Gate

WEB-сервіс обміну документами та квитанціями з приймальним шлюзом

Сценарій подання звітності

1. Відправити документ на шлюз, використовуючи метод Send
2. Зачекати певний час (3-5 секунд)
3. Отримати список кодів повідомлень, використовуючи метод GetMessages або GetMessagesEx
4. Якщо список порожній, зачекати певний час (30-60 секунд) і перейти до п.3
5. Отримати повідомлення, використовуючи метод Receive
6. Вилучити отримане повідомлення, використовуючи метод Delete
7. Якщо повідомлення не останнє в списку, перейти до п.5 для наступного повідомлення
8. Якщо отримано не всі очікувані квитанції, перейти до п.3

Примітка

Рекомендується періодично (1-2 рази на добу) виконувати перевірку наявності повідомлень для отримання документів, що відправлено за ініціативою шлюзу.

Коди повернення функцій

GATE_OK (0) - Успішно
GATE_SEND_FAILED (1) - Помилка збереження вхідного повідомлення
GATE_EMPTY_FILENAME (2) - Не визначено ім'я файлу
GATE_EMPTY_MESSAGE (3) - Блок документу не визначено
GATE_FILENAME_TOOLONG (4) - Некоректне ім'я файлу
GATE_FILENAME_INVALID (5) - Недопустимі символи в імені файлу
GATE_PARSESIGN_FAILED (6) - Помилка перевірки підпису
GATE_DB_INTERNAL (7) - Помилка роботи з базою повідомлень
GATE_MSGID_INVALID (8) - Некоректний код повідомлення
GATE_MSGID_ABSENT (9) - Відсутнє запитане повідомлення
GATE_EMPTY_EMAIL (10) - Не визначено адресу електронної пошти
GATE_TEMPORARY_UNAVAIL (11) - Сервіс тимчасово недоступний
GATE_INVALID_PARAMS (12) - Некоректні параметри

The following operations are supported. For a formal definition, please review the Service Description.

Delete
Вилучити повідомлення
signedMsgId - перелік кодів повідомлень, у вигляді тексту, кожен код з нового рядку, підписаний ЕЦП (блок XXX_SIGN)

GetMessages
Отримати список кодів повідомлень для одержувача
signedEDRPOU - ЄДРПОУ/ДРФО одержувача
messagesList - перелік кодів повідомлень, у вигляді тексту, кожен код з нового рядку

GetMessagesEx
Отримати список кодів повідомлень для одержувача з визначенням адреси електронної пошти
signedEDRPOU - ЄДРПОУ/ДРФО одержувача
senderEmail - адреса електронної пошти відправника документа (така сама як у виклику Send)
messagesList - перелік кодів повідомлень, у вигляді тексту, кожен код з нового рядку

Receive
Отримати повідомлення
signedMsgId - рядок з кодом повідомлення
fileName - ім'я файлу повідомлення
messageData - зміст повідомлення в форматі електронного конверта шлюзу

ReceiveAll
Отримати всі повідомлення
signedEmail - адреса електронної пошти відправника документа (така сама як у виклику Send), підписана ЕЦП (блок XXX_SIGN)
needDelete - ознака необхідності вилучення повідомлень (0/1)
messages - повідомлення
complete - ознака відсутності на час виклику повідомлень, що не повернуті користувачу

Send
Відправити документ на шлюз
fileName - ім'я файлу документа
senderEMail - адреса електронної пошти відправника документа
на яку буде відправлено відповіді, якщо за певний час користувач їх не вилучив викликом методу Delete
data - зміст документа в форматі електронного конверта шлюзу