Ключи API и API

Ключ API — это пароль, который принадлежит программе, а не человеку. Обращайтесь с ним так же: выдавайте один на систему и заменяйте его, когда эта система изменяется.

Создать ключ

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

Каждая ключевая карта показывает разрешения, дату создания, Последнее использование и значок, например, «активен» или «истекает через 5 дней».

Продлить ключ до его истечения

За четырнадцать дней до истечения срока действия ключа Вы получите одно уведомление в колокольчике. Нажмите Продлить на карточке ключа и выберите новую дату истечения срока. IDup создает новый ключ с теми же разрешениями. Скопируйте его сразу, так как это отображение появляется только один раз. Старый ключ остается действительным до истечения его собственного срока, так что Вы можете переключить систему без перерыва.

Области, к которым Вы можете добраться

API охватывает данные ваших клиентов и, в зависимости от вашего плана, объекты и аренду, поисковые профили, налоговые файлы, файлы доверенного лица, бухгалтерию, расчеты заработной платы и сканирование квитанций. AI Studio и почтовый ящик имеют свои собственные области. Руководство по API перечисляет только те области, которые включает ваш план.

Руководство по API

Откройте Документация вкладку на странице управления API, или API → Руководство по API. Каждая область показывает свои поля, примеры запросов, которые Вы можете скопировать, примеры ответов и коды ошибок.

Вебхуки и другие интерфейсы

• Этот Вебхуки вкладка отправляет события в Вашу систему по мере их возникновения — см. Отправлять события в вашу собственную систему с помощью вебхуков.
• Если Customer API включен, a Настройки API клиентов вкладка открывает её настройки, например, могут ли клиенты регистрироваться через API.
• Автоматизация / Рабочие процессы → Технический интерфейс выдаёт токен для интерфейса GraphQL.
• AI Studio → Персональные API ключи это отдельный набор ключей.

Сохраняя в безопасности

1. Один ключ на систему, никогда не общий.
2. Дайте ключу только те разрешения, которые нужны системе.
3. Установите дату истечения срока и продлевайте по расписанию.
4. Удалите ключ, как только кто-то, кто его знал, покинет компанию, или система будет выключена.