Для налаштування та отримання callbacks дотримуйтесь наведеної нижче інструкції
Для того, щоб створити callbacks, вам потрібно виконати наступні вимоги:
- Ви повинні бути користувачем платформи з правами власника принаймні однієї поштової скриньки
- Ви повинні мати URL-адресу, на яку будуть приходити callbacks
- Ви повинні бути знайомі з API (оскільки інтерфейс callback не має користувацького інтерфейсу)
Якщо ви виконали три пункти вище, ви можете приступити до налаштування вашого callback
- Створіть callback, використовуючи наступні дані. Цей callback буде спрацьовувати на кожен отриманий конверт з наступними статусами: ОЧІКУЄ НА ВАС, ЗАВЕРШЕНО, ПРОСТРОЧЕНО, СКАСОВАНО
URL | |
Method | POST |
request URL | /api/v1/envelope/callback/add |
Headers | |
content-type | application/json |
authorization | Bearer {token} де {token} токен авторизації, який користувач отримав після успішної авторизації на платформі |
mailbox | UUID поштової скриньки, на яку ви налаштували callbacks |
REQUEST BODY
{ "filter": {}, "url": "URL which can receive callbacks", "retries": 5, "timeout": 10000, "successCode": 200, "login": "", "password": "" }
- Надішліть хоча б один конверт на поштову скриньку, де був створений callback
- Перейдіть на URL, вказаний у callback, і дочекайтеся callback даних
- Як тільки на вашу URL надійде відповідь, ви побачите наступні JSON-дані (UUID, статус, ярлики, тема, дата, шаблон і відправник будуть вказані у конверті, який ви отримали)
{ "uuid": "74acfb70-78e9-4ca5-ac73-054c72402c0a", "label": ["string"], "status": "string", "subject": "string", "receiveDate": 1676039226765, "expireDate": 1678631226504, "template": "ebeb302b-597e-4b47-9de2-5ad3a33e4385", "sender": "fdfde267-6558-40a9-93fd-e59529baef36" }