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