Entwickler
Bauen Sie aufder Mateflow-API auf.
Ein Schlüssel, eine Community. Beiträge, Feeds, Spaces und Mitglieder lesen, im Namen Ihrer Leute veröffentlichen und jedes Ereignis per Webhook empfangen — alles aus einer einzigen JSON-API.
Funktionsumfang
Alles, was Sie zur Integration brauchen
API-Schlüssel mit Scopes
Erstellen Sie Schlüssel in der Admin-Konsole Ihrer Community und geben Sie jedem nur die Scopes, die er braucht. Authentifiziert wird über den Header X-API-Key — es gibt keine Sitzung zu verwalten.
Ab Growth
JSON-API
Lesen und schreiben Sie Ihre Community über einen einheitlichen Umschlag. Alle Endpunkte liegen unter /site_open_api/v1, nehmen POST mit JSON-Body entgegen und leiten die Community aus Ihrem Schlüssel ab.
Ab Growth
Webhooks
Registrieren Sie Endpunkte, um Ereignisse zu erhalten, sobald sie passieren. Jede Zustellung trägt eine stabile event_id, mit der sich Wiederholungen entdoppeln lassen — dieselbe id erreicht auch Slack, Discord und Zapier.
Ab Growth
Integrationen
Verbinden Sie Slack, Discord und Zapier über den Integrations-Hub, stöbern Sie im App-Katalog und verwalten Sie alle verbundenen Apps an einem Ort.
Single Sign-on
Bündeln Sie die Authentifizierung für Ihr Team und Ihre Mitglieder, statt einen zweiten Satz Zugangsdaten zu pflegen.
Ab Business
Zustellprotokolle
Jeder Zustellversuch eines Webhooks wird mit Payload und Antwort protokolliert. Sehen Sie sich eine fehlgeschlagene Zustellung an, prüfen Sie, was Sie zurückgegeben haben, und wiederholen Sie sie aus der Konsole.
Ab Growth
24 Endpunkte, ein Umschlag
Alles liegt unter https://api.mateflow.com/site_open_api/v1 und nutzt POST mit JSON-Body. Dies sind die, mit denen die meisten Integrationen beginnen — die vollständige Liste steht in der Referenz.
- POST/capabilities/getkein ScopeSchlüssel, Scopes und Restkontingent prüfen
- POST/site/getsite.readProfil und Einstellungen der Community lesen
- POST/feed/listcontent.readDurch den Community-Feed blättern
- POST/post/searchcontent.readBeiträge durchsuchen
- POST/post/createcontent.writeAls Mitglied veröffentlichen
- POST/space/listspaces.readSpaces auflisten, die der Betrachter sieht
- POST/member/lookupmembers.readEine E-Mail-Adresse einem Mitglied zuordnen
- POST/media/get_tokenmedia.writeEin Upload-Token für Medien holen
Schnellstart
In drei Schritten loslegen
API-Zugang aktivieren
Der API-Zugang ist eine Tariffunktion, die die Person aktiviert, der die Community gehört. Ohne sie gibt jeder Aufruf 22203 zurück, und es lässt sich kein Schlüssel anlegen — fangen Sie hier an, nicht in Ihrem Code.
Einen Schlüssel mit Scopes erstellen
Community-Verwaltung → Integrationen → API Keys. Wählen Sie nur die Scopes, die Sie brauchen; sie stehen fest, sobald der Schlüssel existiert. Der vollständige Schlüssel wird genau einmal angezeigt.
Zuerst /capabilities/get aufrufen
Er nennt Ihre Scopes, ob der API-Zugang aktiv ist und wie viel Kontingent übrig ist — und er ist der einzige Endpunkt, der noch antwortet, wenn Tarifschranke oder Kontingent alles andere blockieren. Kontingent verbraucht er nicht.
Nutzung und Limits
Was jeder Tarif erlaubt
Das Tageskontingent zählt jede Anfrage, die die Authentifizierung passiert, und wird um 00:00 UTC zurückgesetzt. Ein Kontingent von null ist eine verschlossene Tür, kein nicht gesetzter Standardwert — es gibt bei jedem Aufruf 22204 zurück.
| Tarif | Offene API | Anfragen pro Tag | Webhook-Endpunkte |
|---|---|---|---|
| Starter | Nicht enthalten | — | — |
| Growth | Enthalten | 5,000 | 5 |
| Business | Enthalten | 10,000 | 20 |
| Enterprise | Enthalten | Unbegrenzt | Unbegrenzt |
Zusätzlich zum Tageskontingent gelten Burst-Limits, die pro Schlüssel greifen — siehe Ratenbegrenzung in der Referenz.
Ihr erster Aufruf, dreimal
Dieselbe Anfrage in jeder Sprache: Stellen Sie sicher, dass der Schlüssel funktioniert, bevor Sie irgendetwas anderes schreiben. Ersetzen Sie mfk_xxx durch einen echten Schlüssel aus Ihrer Konsole.
curl -X POST \
https://api.mateflow.com/site_open_api/v1/capabilities/get \
-H "X-API-Key: mfk_xxx" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch(
"https://api.mateflow.com/site_open_api/v1/capabilities/get",
{
method: "POST",
headers: {
"X-API-Key": process.env.MATEFLOW_API_KEY,
"Content-Type": "application/json",
},
// Endpoints that take no parameters still want a JSON body.
body: "{}",
},
);
const { code, data } = await res.json();
// Branch on `code`, never on the HTTP status:
// 22203 and 22204 are 403, and only 10202 is throttling.
if (code !== 0) throw new Error(`Mateflow API error ${code}`);
console.log(data.scopes, data.quota_used, data.quota_limit);import os, requests
res = requests.post(
"https://api.mateflow.com/site_open_api/v1/capabilities/get",
headers={"X-API-Key": os.environ["MATEFLOW_API_KEY"]},
json={},
)
body = res.json()
if body["code"] != 0:
raise RuntimeError(f"Mateflow API error {body['code']}")
print(body["data"]["scopes"], body["data"]["api_access"])OpenAPI-Vertrag
Der maschinenlesbare Vertrag deckt jeden Pfad und jedes Request- und Response-Schema ab und lässt sich jedem Client-Generator übergeben. Offizielle SDKs stehen auf der Roadmap; bis dahin generieren Sie sich eins.
Referenz
Die vollständige API-Referenz
Scopes, Paginierung, Idempotenz, Fehlercodes, Ratenbegrenzung, Webhook-Entdopplung — und die Handvoll Ausnahmen, die erst nach dem Livegang zubeißen.
Bereit loszulegen?
Legen Sie ein Konto an, erzeugen Sie Ihre API-Schlüssel und binden Sie Mateflow in Ihre Abläufe ein.
14 Tage kostenlos testen · Keine Kreditkarte erforderlich