API ключове и достъп на външни системи
Страницата "API ключове" е реалният екран, от който управлявате API достъпа на външни системи до вашите данни.
Кога да използвате тази страница
- когато CRM, сайт, мобилно приложение или друга външна система трябва да работи с данните ви през API;
- когато искате да дадете различен достъп на различни външни системи;
- когато трябва да спрете, ограничите или изтриете вече даден достъп.
Достъп
- Отворете Интеграции.
- Изберете "API ключове".
Какво виждате в списъка
- "Име"
- "Изтича на" (или "Никога")
- "Активен"
- Действия: "Редактирай API ключ", "Изтрий API ключ"
Създаване на нов ключ
- Изберете "Нов API ключ".
- Попълнете "Име" (задължително), "Изтича на" (по избор), "Активен" и "Избери права".
- Изберете "Създай".
- Съхранете показания токен и го предайте сигурно на външната система.
Какво означава всяко поле
- "Име" е вашето вътрешно описание на ключа.
- "Изтича на" определя до кога ключът ще работи. Ако полето е празно, ключът няма срок.
- "Активен" включва или спира ключа без да го изтривате.
- "Избери права" определя кои ресурси и действия ще бъдат достъпни през този ключ.
Как работят правата
- Правата се избират поотделно за всеки ключ.
- Ключът има достъп само до ресурсите и действията, за които сте избрали права.
- Ако достъпът трябва да е по-ограничен, създайте отделен ключ с по-малко права.
Как да управлявате вече създаден ключ
- използвайте "Редактирай API ключ", когато трябва да смените име, срок, активност или права;
- изключете "Активен", ако искате временно да спрете достъпа;
- използвайте "Изтрий API ключ", ако достъпът вече не е нужен.
Как работи достъпът през API
- Външната система използва токена като
Authorization: Bearer <api-key>. - Достъпът зависи от това ключът да е активен, да не е изтекъл и да има нужните права.
- Освен това бизнесът трябва да има активна функционалност
external_connectivityв абонамента си.
Какво е налично в текущия продукт
- JSON:API v2 поддържа достъп с API ключ.
- В публичната v2 спецификация са документирани ресурси като услуги, свободни часове, резервации, работно време, вноски и плащания.
- При липса на активна функционалност
external_connectivity, част от заявките могат да върнат402 Payment Required.
Критично за сигурността
- След създаване системата показва "Токен за достъп до API" в отделен прозорец.
- Този токен се вижда само веднъж. След затваряне не може да бъде показан отново.
- Съхранявайте токена сигурно и не го споделяйте.
Какво не е налично в текущия интерфейс
- "Логове" присъства в менюто, но в текущия интерфейс е неактивно.
- Ако редактирате вече съществуващ ключ, системата не показва стария токен отново. Показването му е само при създаване.
- В Business интерфейса няма отделен екран за webhook настройка.