ioumi-API: API-Token anlegen und Berechtigungen setzen
Über die ioumi-API sprechen andere Programme direkt mit ioumi. Dein CRM, dein Funnel oder ein Automatisierungstool wie Make, Zapier oder n8n kann damit Daten in ioumi lesen und anlegen, ohne dass jemand von Hand klicken muss. So hältst du deine Daten zwischen ioumi und deinen anderen Tools automatisch abgeglichen.
API oder Webhook?
Abschnitt betitelt „API oder Webhook?“| API | Webhook | |
|---|---|---|
| Richtung | Dein System fragt ioumi oder schickt Daten an ioumi | ioumi meldet sich bei deinem System |
| Wann | Wenn dein System etwas braucht oder anlegen will | Sofort, wenn in ioumi etwas passiert |
| Beispiel | Kunde aus dem CRM in ioumi anlegen | Vertrag unterschrieben, Onboarding im Projekttool starten |
Oft nutzt du beides zusammen. Wie Webhooks funktionieren, erklärt der Artikel Webhooks.
Was du mit der API machen kannst
Abschnitt betitelt „Was du mit der API machen kannst“Über die API erreichst du die zentralen Bereiche von ioumi, von Kontakten über Verträge bis zu Verkäufen und Zahlungen. Du kannst Daten abrufen, neu anlegen und aktualisieren. Welche Funktionen es im Einzelnen gibt, siehst du in der API-Dokumentation. Wir bauen die API laufend weiter aus.
Für alles, was du über die API anlegst, gelten dieselben Regeln wie in ioumi selbst, etwa bei der Umsatzsteuer oder bei Zahlungsplänen. Was in der App nicht zulässig ist, lehnt auch die API ab.
Typische Anwendungsfälle
Abschnitt betitelt „Typische Anwendungsfälle“- Neue Leads aus deinem CRM oder Funnel automatisch als Kontakte in ioumi anlegen
- Nach der Vertragsunterschrift automatisch den Zugang zu deinem Kurs oder deiner Community freischalten, zusammen mit einem Webhook
- Verkäufe und Zahlungen in dein eigenes Reporting übernehmen
- Rechnungen aus deinem eigenen Rechnungsprogramm an ioumi zurückmelden, siehe Externer Rechnungsmodus
API-Token anlegen
Abschnitt betitelt „API-Token anlegen“Jede Anfrage an die API braucht einen API-Token. Er weist nach, dass die Anfrage von dir kommt, und legt fest, was sie darf.
- Öffne Einstellungen › Integrationen.
- Klicke bei API-Tokens auf API-Tokens generieren.
- Gib dem Token einen Namen, an dem du später erkennst, wofür er ist, zum Beispiel „Make Lead-Import“.
- Wähle unter Berechtigungen nur das aus, was diese Anbindung wirklich braucht.
- Klicke auf Generieren und kopiere den Token sofort.
Berechtigungen
Abschnitt betitelt „Berechtigungen“Für jeden Token legst du fest, was er darf, getrennt nach Bereich und danach, ob er Daten nur lesen oder auch anlegen und ändern darf. Besonders folgenreiche Aktionen, wie das Versenden von Verträgen oder Rückerstattungen, gibst du einzeln frei.
Du kannst beliebig viele Tokens mit unterschiedlichen Berechtigungen anlegen. Lege lieber mehrere Tokens mit wenigen Rechten an als einen mit allen, zum Beispiel einen eigenen Token für den Lead-Import, der nur Kontakte anlegen darf. Wird ein Token einmal nicht mehr gebraucht, löschst du genau diesen, ohne die anderen Anbindungen zu stören.
Die API-Dokumentation
Abschnitt betitelt „Die API-Dokumentation“Die vollständige technische Referenz mit allen Endpunkten, Feldern und Beispielen findest du in ioumi unter Einstellungen › Integrationen › API-Dokumentation. Sie ist für Entwickler gedacht, die die Anbindung umsetzen.