Перейти к содержимому

Developer API

Вкладка Developers — место выпуска API-ключей для программного доступа к Entergram. Доступно на тарифе Pro (и Pro-местах рабочего пространства). Только для owners и admins.

  1. «Create API key»
  2. Назовите его (так, чтобы узнать его в списке отзыва позже)
  3. Выберите scope-ы — точечные права, такие как:
    • workspace.read
    • members.read
    • accounts.read
    • contacts.read
    • chats.read / chats.write
    • custom_fields.read / custom_fields.write
  4. TTL по умолчанию — 90 дней; можно выбрать меньше
  5. Опционально: ограничьте по списку IP CIDR
  6. Нажмите Create — полный ключ показывается один раз. Скопируйте его сразу; Entergram больше его не покажет.
  • Ключи хранятся как односторонние хеши — сырой ключ никогда не попадает на диск
  • Каждый запрос пишет в журнал префикс, IP и user agent для аудита
  • Отзыв немедленный
  • Истекшие ключи автоматически возвращают 403
  • Каждый API-вызов ограничен рабочим пространством — ключ работает только в том пространстве, что его выпустило

С вкладки Developers:

  • Видите по каждому ключу префикс, дату создания, scope-ы, TTL и информацию о последнем использовании
  • Копируете префикс (не секрет)
  • Отзываете или ротируете ключ
  • Ротация = создаёте новый ключ с теми же scope-ами, затем отзываете старый, как только интеграция переключена
  1. Вы понимаете, что инженер вставил ключ в публичный issue tracker
  2. Вкладка Developers → найдите ключ → Revoke (срабатывает мгновенно)
  3. Создайте новый ключ с теми же scope-ами и IP-allowlist
  4. Разверните новый ключ в интеграции
  5. Проверьте last-used старого ключа, чтобы убедиться, что трафика больше нет
  1. Вкладка Developers → Create API key
  2. Назовите ci-deploy-bot
  3. Scope-ы: только workspace.read и chats.read (минимально необходимые)
  4. TTL: 30 дней
  5. IP allowlist: egress IP CI-провайдера
  6. Скопируйте ключ и положите в секреты CI
  7. Ротируйте до истечения TTL

Тарифы Pro включают интеграцию с Make.com — Вы можете подключить Entergram к low-code автоматизациям, не написав ни строчки API-кода. Доступно из раздела интеграций рабочего пространства.

Распространённые HTTP-ошибки:

  • 401 — ключ истёк, отозван или не для этого рабочего пространства
  • 403 — у ключа нет нужного scope или запрос с IP вне allowlist
  • 429 — Вы упёрлись в rate limit; снизьте темп и повторите