Інтеграції: ключі API та вебхуки

Ключі API

Система → Інтеграції → Ключі API. Ключ дає програмі ззовні доступ до сайту від вашого імені, але лише до того, що ви позначите. Ключ не може більше, ніж ви самі: знімуть із вас право — ключ його теж втратить.

1. Натисніть «додати», назвіть ключ для себе («склад») і позначте права.
2. Скопіюйте ключ одразу: він показаний один раз, сайт зберігає лише його відбиток і показати ключ ще раз не зможе. Загубили — видайте новий.
3. Програма надсилає ключ заголовком Authorization: Bearer nx_… на адреси під /api/v1.
4. Відкликати ключ можна будь-якої хвилини: програма з ним одразу втратить доступ.

Опис усіх доступних ключу точок є файлом OpenAPI: кнопка «Завантажити опис API» віддає його для Postman і генераторів клієнтів. У файлі лише точки, на які вистачає ваших прав; самих ключів там немає. Той самий файл програма може взяти сама: GET /api/v1/openapi.json з ключем. Точка /api/v1/me відповідає, чий це ключ, до якого строку й які права він має зараз.

Вебхуки

Система → Інтеграції → Вебхуки. Коли на сайті щось сталося — оплатили замовлення, завели обліковий запис, — сайт сам повідомляє про це на вказану вами адресу. Повідомлення йдуть через чергу й повторюються, якщо той кінець не відповів; поруч із вебхуком видно час останнього надсилання і кількість невдач поспіль.

• Адреса потрібна зовнішня, повна, з https:// або http://. На адреси всередині сервера й локальної мережі сайт не стукає — це захист від того, щоб вебхук не став лазівкою всередину вашої мережі.
• Кожне повідомлення підписане: заголовок X-Nex1on-Signature — це підпис sha256 від тіла повідомлення, обчислений із вашим «секретом для підпису». Сторона, що приймає, обчислює той самий підпис і так дізнається, що повідомлення прийшло з вашого сайту.
• «Видати новий секрет» замінює попередній; сторону, що приймає, після цього потрібно переналаштувати.
• Список подій залежить від увімкнених модулів: немає модуля — немає і його подій.