Developer API
Вкладка Developers — место выпуска API-ключей для программного доступа к Entergram. Доступно на тарифе Pro (и Pro-местах рабочего пространства). Только для owners и admins.
Создание ключа
Заголовок раздела «Создание ключа»- «Create API key»
- Назовите его (так, чтобы узнать его в списке отзыва позже)
- Выберите scope-ы — точечные права, такие как:
workspace.readmembers.readaccounts.readcontacts.readchats.read/chats.writecustom_fields.read/custom_fields.write
- TTL по умолчанию — 90 дней; можно выбрать меньше
- Опционально: ограничьте по списку IP CIDR
- Нажмите Create — полный ключ показывается один раз. Скопируйте его сразу; Entergram больше его не покажет.
Под капотом
Заголовок раздела «Под капотом»- Ключи хранятся как односторонние хеши — сырой ключ никогда не попадает на диск
- Каждый запрос пишет в журнал префикс, IP и user agent для аудита
- Отзыв немедленный
- Истекшие ключи автоматически возвращают 403
- Каждый API-вызов ограничен рабочим пространством — ключ работает только в том пространстве, что его выпустило
Управление ключами
Заголовок раздела «Управление ключами»С вкладки Developers:
- Видите по каждому ключу префикс, дату создания, scope-ы, TTL и информацию о последнем использовании
- Копируете префикс (не секрет)
- Отзываете или ротируете ключ
- Ротация = создаёте новый ключ с теми же scope-ами, затем отзываете старый, как только интеграция переключена
Пример: ротация утечённого ключа
Заголовок раздела «Пример: ротация утечённого ключа»- Вы понимаете, что инженер вставил ключ в публичный issue tracker
- Вкладка Developers → найдите ключ → Revoke (срабатывает мгновенно)
- Создайте новый ключ с теми же scope-ами и IP-allowlist
- Разверните новый ключ в интеграции
- Проверьте last-used старого ключа, чтобы убедиться, что трафика больше нет
Пример: ключ для CI-задачи
Заголовок раздела «Пример: ключ для CI-задачи»- Вкладка Developers → Create API key
- Назовите
ci-deploy-bot - Scope-ы: только
workspace.readиchats.read(минимально необходимые) - TTL: 30 дней
- IP allowlist: egress IP CI-провайдера
- Скопируйте ключ и положите в секреты CI
- Ротируйте до истечения TTL
Интеграция с Make.com
Заголовок раздела «Интеграция с Make.com»Тарифы Pro включают интеграцию с Make.com — Вы можете подключить Entergram к low-code автоматизациям, не написав ни строчки API-кода. Доступно из раздела интеграций рабочего пространства.
Ответы API
Заголовок раздела «Ответы API»Распространённые HTTP-ошибки:
- 401 — ключ истёк, отозван или не для этого рабочего пространства
- 403 — у ключа нет нужного scope или запрос с IP вне allowlist
- 429 — Вы упёрлись в rate limit; снизьте темп и повторите