Що таке API-ключ
API-ключ — це секретний рядок, який підтверджує, що інша система має право читати ваші дані. Він працює як пароль, але його передає програма, а не людина, і він залишається чинним, доки ви його не відкличете.
Варто знати: редактор і обліковий запис Gatherino доступні англійською або чеською мовами. Форми, які заповнюють ваші респонденти, можна показувати 18 мовами, зокрема українською.
Ключ створюється в налаштуваннях і показується лише один раз. Одразу збережіть його у змінній середовища або в менеджері секретів на вашому сервері: прочитати його пізніше не можна, оскільки він зберігається у вигляді, з якого неможливо відновити початкове значення.
Найпоширенішою помилкою є розміщення ключа в JavaScript на сторінці. Код у браузері є публічним: будь-хто може скопіювати ключ і завантажити кожну відповідь з кожної вашої форми. Тому виклики API мають виконуватися на сервері, який зберігає ключ і повертає лише те, що призначено для публічного доступу.
Якщо ключ витік, не з'ясовуйте, чи хтось ним скористався, — відкличте його і випустіть новий. Відкликання відбувається миттєво, а старий ключ перестає працювати.
На практиці
- Ключ має зберігатися у серверній змінній середовища, а не в репозиторії та не на фронтенді.
- Краще використовувати окремий ключ для кожної інтеграції, щоб за потреби відкликати лише ключ конкретної інтеграції.
- Замінюйте ключ, коли людина, яка його знала, покидає компанію.
Часті питання
Де створити API-ключ?
У розділі Налаштування → API-ключі. Він відображається лише один раз.
Як передається ключ?
У заголовку Authorization: Bearer <ключ> або в заголовку x-api-key.
Що відбувається, коли я відкликаю ключ?
Він миттєво перестає працювати, а інтеграції, які його використовують, отримують помилку 401.
Схожі матеріали
Спробуйте Gatherino безкоштовно
Безкоштовний тариф: 3 форми та 100 відповідей на місяць. Банківська картка не потрібна, дані зберігаються в ЄС.
Почніть безкоштовно →