Mit einem API-Schlüssel kann ein Entwickler oder ein Tool, das du betreibst, über die Mateflow Open API die Daten deiner Community lesen und schreiben. Du erstellst und widerrufst API-Schlüssel unter Admin → Einstellungen → Integrationen → API-Zugang. Jeder Schlüssel funktioniert nur für eine Community.
Wer kann das tun: Inhaber und Administratoren. · Wo: Web (Admin-Konsole). · Tarif: API-Zugang und die Anzahl der API-Anfragen, die deine Community pro Tag stellen kann, hängen von deinem Plattform-Tarif ab.
API-Schlüssel gelten pro Community
API-Schlüssel gehören zu genau einer Community, und Anfragen mit einem Schlüssel wirken immer auf diese Community. Um mehrere Communitys anzubinden, erstelle in der Admin-Konsole jeder Community einen eigenen Schlüssel.
Das Creator-Dashboard (app.mateflow.com) hat keine API-Schlüssel. Die Schlüssel auf Workspace-Ebene, die es dort gab, wurden durch Schlüssel pro Community ersetzt. Die Seite Übersicht einer Community im Dashboard verlinkt auf ihre Seite Integrationen.
API-Schlüssel erstellen
- Gehe zu Admin → Einstellungen → Integrationen und öffne den Tab API-Zugang.
- Klicke auf Neuen Schlüssel generieren.
- Gib einen Schlüsselname ein, der sagt, wofür er gedacht ist, etwa das Tool, das ihn verwenden wird.
- Hake unter Scopes & Berechtigungen nur die Berechtigungen an, die die Integration braucht. Siehe den nächsten Abschnitt.
- Optional: Gib unter IP-Whitelist (optional) die IP-Adressen oder -Bereiche ein, die den Schlüssel verwenden dürfen, durch Kommas getrennt.
- Klicke auf Neuen Schlüssel generieren.
- Kopiere den Schlüssel aus API-Schlüssel generiert, bewahre ihn sicher auf und klicke dann auf Fertig.
Du siehst den vollständigen Schlüssel nur ein einziges Mal. Wenn du ihn verlierst, generiere einen neuen Schlüssel und widerrufe den alten.
Wenn der Tab API-Zugang einen Upgrade-Hinweis zeigt, enthält dein Plattform-Tarif keinen API-Zugang. Die Karte API-Endpunkt zeigt die Basis-URL für Anfragen und das tägliche Anfragelimit deines Tarifs, das um 00:00 Uhr UTC zurückgesetzt wird.
Scopes (Berechtigungen) für API-Schlüssel
| Scope | Was er erlaubt |
|---|---|
| Community lesen | Profil, Einstellungen und Metadaten der Community lesen |
| Inhalte lesen | Beiträge, Feeds, Antworten und Suchergebnisse lesen |
| Inhalte schreiben | Beiträge und Antworten erstellen, bearbeiten und löschen |
| Medien hochladen | Upload-Tokens anfordern; umfasst auch das Lesen signierter Medien-URLs |
| Medien lesen | Signierte URLs für vorhandene Medien lesen |
| Spaces lesen | Spaces auflisten und Space-Details lesen |
| Mitglieder lesen | Mitglieder nachschlagen und Basisprofile lesen, einschließlich ihrer Zugriffsgruppen |
| Mitglieder einladen | Personen per E-Mail oder über einen Einladungslink einladen |
Mitglieder lesen und Mitglieder einladen sind unter Sensibler Zugriff aufgeführt. Mit Mitglieder lesen kann die Integration prüfen, ob eine E-Mail-Adresse zu deiner Community gehört. Mit Mitglieder einladen werden Einladungen im Namen des Community-Inhabers gesendet, sofern die Integration keine andere einladende Person angibt, und eingeladene Personen treten immer als Mitglieder bei. API-Einladungen können Zugriffsgruppen enthalten. Siehe So funktionieren Zugriffsgruppen.
Die Scopes eines Schlüssels lassen sich später nicht ändern. Ältere Schlüssel zeigen möglicherweise Alle (veraltet): Sie behalten nur die Scopes, die es bei ihrer Erstellung gab. Erstelle einen neuen Schlüssel, um neuere Scopes zu nutzen.
API-Schlüssel widerrufen
- Suche im Tab API-Zugang den Schlüssel unter API-Schlüssel.
- Öffne sein Aktionsmenü und klicke auf Schlüssel widerrufen.
- Bestätige. Das Widerrufen kann nicht rückgängig gemacht werden, und jedes Tool, das den Schlüssel verwendet, funktioniert nicht mehr.
Die Liste zeigt für jeden Schlüssel den Status (Aktiv, Abgelaufen oder Widerrufen) und das Datum Zuletzt verwendet. API-Anfragen erscheinen nicht unter Zustellprotokolle, daher prüfst du über Zuletzt verwendet, ob ein Schlüssel noch genutzt wird. Wenn du Slack, Discord oder Zapier trennst, wird dadurch kein API-Schlüssel widerrufen.
API-Schlüssel sicher aufbewahren
- Bewahre API-Schlüssel auf einem Server auf, nicht in einer Website oder App, die andere herunterladen können, und sende Anfragen über HTTPS.
- Gib jedem Tool einen eigenen Schlüssel mit nur den Scopes, die es braucht, damit du einen widerrufen kannst, ohne die anderen lahmzulegen.
- Füge eine IP-Whitelist hinzu, wenn das Tool von festen Adressen aus aufruft.
- Widerrufe einen Schlüssel sofort, wenn er möglicherweise öffentlich geworden ist, und erstelle dann einen Ersatz.
Wo du die API-Dokumentation findest
Die API-Referenz behandelt Endpunkte, Request- und Response-Formate, Scopes, Fehlercodes und Codebeispiele. Im Tab API-Zugang hat die Karte Entwicklerdokumentation eine Schaltfläche Dokumentation öffnen, die zu mateflow.com/developers führt. Schicke diesen Link an deinen Entwickler. Er braucht kein Konto in deiner Community, und die Seite ist auch verfügbar, wenn dein Tarif keinen API-Zugang enthält.
Verwandte Artikel
War dieser Leitfaden hilfreich?