Ключі API та API

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

Створити ключ

1. Відкрити API → Управління API і натисніть Новий ключ.
2. Дайте йому назву, яка вказує, яка система його використовує.
3. Виберіть його Дозволи: Повний доступ, або лише ті області, які потрібні системі. Більшість областей розрізняють читання, створення та зміну.
4. Виберіть дату закінчення терміну або жодну.
5. Використовуйте Показати і Копіювати на картці ключа, щоб передати ключ викликаючій системі. Система відправляє його в authtoken заголовок.

Кожна ключова картка показує дозволи, дату створення, Останнє використання і значок, такий як «активний» або «закінчується через 5 днів».

Оновити ключ до його закінчення

За чотирнадцять днів до закінчення терміну дії ключа Ви отримаєте одне сповіщення у дзвіночку. Натисніть Оновити на картці ключа і виберіть нову дату закінчення терміну дії. IDup створює новий ключ з тими ж дозволами. Скопіюйте його одразу, оскільки це відображення з'являється лише один раз. Старий ключ залишається дійсним до закінчення його терміну, тому Ви можете переключити систему без перерви.

Області, до яких Ви можете дістатися

API охоплює дані Ваших клієнтів і, залежно від Вашого плану, нерухомість та оренду, пошукові профілі, податкові файли, файли довірених осіб, бухгалтерію, виплати заробітної плати та сканування квитанцій. AI Studio та поштовий ящик мають свої власні області. Посібник з API містить лише ті області, які включені у Ваш план.

Посібник з API

Відкрити Документація вкладка на сторінці управління API, або API → Посібник API. Кожна область показує свої поля, приклади запитів, які Ви можете скопіювати, приклади відповідей та коди помилок.

Вебхуки та інші інтерфейси

• Це Вебхуки вкладка надсилає події у вашу систему, як тільки вони відбуваються — дивіться Надіслати події у вашу власну систему за допомогою вебхуків.
• Якщо API клієнта увімкнено, a Налаштування API клієнтів вкладка відкриває її налаштування, наприклад, чи можуть клієнти реєструватися через API.
• Автоматизація / Робочі процеси → Технічний інтерфейс видає токен для інтерфейсу GraphQL.
• AI Studio → Персональні API ключі це окремий набір ключів.

Збереження безпеки

1. Один ключ на систему, ніколи не спільний.
2. Надайте ключу лише ті дозволи, які потрібні системі.
3. Встановіть дату закінчення терміну дії та поновлюйте за розкладом.
4. Видаліть ключ, як тільки хтось, хто його знав, залишає, або система вимикається.