Developer API
Im Tab “Developers” stellen Sie API-Schlüssel für den programmatischen Zugriff auf Entergram aus. Verfügbar im Pro-Tarif (und bei Pro-Workspace-Sitzen). Nur Owner und Admins.
Einen Schlüssel erstellen
Abschnitt betitelt „Einen Schlüssel erstellen“- “API-Schlüssel erstellen”
- Benennen Sie ihn (etwas, das Sie später in einer Widerrufsliste wiedererkennen)
- Wählen Sie Scopes — feingranulare Berechtigungen wie z. B.:
workspace.readmembers.readaccounts.readcontacts.readchats.read/chats.writecustom_fields.read/custom_fields.write
- Standard-TTL beträgt 90 Tage; Sie können eine kürzere Dauer wählen
- Optional: auf eine Liste von IP-CIDR-Bereichen einschränken
- Klicken Sie auf “Erstellen” — der vollständige Schlüssel wird einmal angezeigt. Kopieren Sie ihn sofort; Entergram zeigt ihn nie wieder an.
Unter der Haube
Abschnitt betitelt „Unter der Haube“- Schlüssel werden als Einweg-Hashes gespeichert — der rohe Schlüssel liegt nie auf der Festplatte
- Jede Anfrage protokolliert Präfix, IP und User-Agent zur Auditierung
- Widerruf erfolgt sofort
- Abgelaufene Schlüssel geben automatisch 403 zurück
- Jeder API-Aufruf ist workspace-bezogen — ein Schlüssel kann nur auf dem Workspace operieren, der ihn ausgestellt hat
Schlüssel verwalten
Abschnitt betitelt „Schlüssel verwalten“Im Tab “Developers”:
- Sehen Sie zu jedem Schlüssel Präfix, Erstellungsdatum, Scopes, TTL und Informationen zur letzten Nutzung
- Präfix kopieren (nicht das Geheimnis)
- Einen Schlüssel widerrufen oder rotieren
- Rotieren = einen neuen Schlüssel mit denselben Scopes erstellen, dann den alten widerrufen, sobald Ihre Integration umgestellt ist
Beispiel: einen geleakten Schlüssel rotieren
Abschnitt betitelt „Beispiel: einen geleakten Schlüssel rotieren“- Sie merken, dass ein Entwickler einen Schlüssel in einen öffentlichen Issue Tracker eingefügt hat
- Tab “Developers” → Schlüssel finden → Widerrufen (sofort wirksam)
- Erstellen Sie einen neuen Schlüssel mit denselben Scopes und derselben IP-Allowlist
- Stellen Sie den neuen Schlüssel in Ihrer Integration bereit
- Prüfen Sie die Info zur letzten Nutzung des alten Schlüssels, um zu bestätigen, dass kein Traffic mehr fließt
Beispiel: einen Schlüssel für einen CI-Job ausstellen
Abschnitt betitelt „Beispiel: einen Schlüssel für einen CI-Job ausstellen“- Tab “Developers” → API-Schlüssel erstellen
- Benennen Sie ihn
ci-deploy-bot - Scopes: nur
workspace.readundchats.read(geringste Rechte) - TTL: 30 Tage
- IP-Allowlist: die Egress-IPs des CI-Anbieters
- Schlüssel kopieren und als Secret in CI hinterlegen
- Vor Ablauf der TTL rotieren
Make.com-Integration
Abschnitt betitelt „Make.com-Integration“Pro-Tarife enthalten eine Make.com-Integration, sodass Sie Entergram in Low-Code-Automatisierungen einbinden können, ohne selbst API-Code zu schreiben. Verfügbar im Workspace-Integrationsbereich.
API-Antworten
Abschnitt betitelt „API-Antworten“Häufige HTTP-Fehler, die Ihnen begegnen:
- 401 — der Schlüssel ist abgelaufen, widerrufen oder falsch für den Workspace
- 403 — dem Schlüssel fehlt der benötigte Scope, oder die Anfrage stammt von einer IP außerhalb der Allowlist
- 429 — Sie haben ein Rate-Limit erreicht; warten Sie ab und versuchen Sie es erneut