Loading
In diesem Artikel erfahren Sie, wie Sie die systeme.io öffentliche API konfigurieren und verwenden, einschließlich der Erstellung von API-Schlüsseln und der verfügbaren Aktionen.
1. Was ist eine API?
Die Abkürzung API steht für "Application Programming Interface", eine Reihe von Anweisungen, mit denen eine Plattform anderen Plattformen Dienste anbietet. Es ist ein strategisches Gateway für externe Entwickler, das ihnen ermöglicht, auf bestimmte Funktionen oder Daten einer Plattform in einer strukturierten und sicheren Weise zuzugreifen. Es ist wie ein Satz von sofort einsatzbereiten Werkzeugen, die es einfach machen, neue Anwendungen, Dienste oder Kombinationen zu erstellen.
Kurz gesagt, systeme.io öffnet sich anderen Plattformen, um seine Dienste dort anzubieten, wo sie Mehrwert schaffen.
2. Wie funktioniert unsere öffentliche API?
Unsere API bietet eine sorgfältig ausgewählte Reihe von Features, die es Entwicklern ermöglicht, transparent und effizient mit unserer Plattform zu interagieren. Wenn Sie mehr darüber erfahren möchten, wie sie funktioniert, können Sie unsere offizielle API-Dokumentation lesen.
3. Wie Sie Ihre API-Schlüssel erstellen
API-Schlüssel sind eindeutige Kennungen, die Anfragen an unsere öffentliche API authentifizieren. Sie ermöglichen Ihnen den programmgesteuerten Zugriff auf verschiedene Ressourcen auf unserer Plattform.
Um einen öffentlichen API-Schlüssel zu erstellen, klicken Sie auf Ihr Profilbild, wählen Sie Einstellungen (1) und scrollen Sie nach unten zu MCP & API-Schlüssel (2).
Klicken Sie auf Erstellen (3), um die Erstellung eines öffentlichen API-Schlüssels zu starten.
Geben Sie im Popup Öffentlichen API-Schlüssel erstellen einen Namen ein und wählen Sie ein Ablaufdatum sowie eine Uhrzeit für Ihren API-Schlüssel aus.
Klicken Sie anschließend auf Speichern (4).
Hinweis: Um Ihren API-Schlüssel dauerhaft aktiv zu halten, lassen Sie das Feld Ablaufdatum leer.
Ihr Schlüssel ist nun bereit.
4. Was können Sie mit unserer API tun?
Unsere API eröffnet einige interessante Möglichkeiten. Nachfolgend finden Sie die Hauptaktionen, die Sie mit unserer öffentlichen API durchführen können:
a. Kontakte, Tags und benutzerdefinierte Felder:
- Kontakte verwalten: Neue Kontakte erstellen, bestehende aktualisieren, Ihre Zielgruppe mit erweiterten Filtern auflisten oder Kontakte löschen.
- Tags verwalten: Tags für Kontakte erstellen, zuweisen, auflisten und entfernen.
- Benutzerdefinierte Felder: Verfügbare benutzerdefinierte Kontaktfelder und deren Kennungen (Slugs) abrufen, um Kontaktinformationen korrekt zu füllen.
b. Newsletter:
- Newsletter erstellen und aktualisieren: Neue Newsletter-Entwürfe erstellen oder vorhandene teilweise aktualisieren. Sie können den Editor-Typ (Klassisch oder Visuell) festlegen, den vollständigen HTML-Inhalt abrufen und explizit den Namen und die E-Mail-Adresse des Absenders setzen.
- Auflisten und abrufen: Durchsuchen Sie Ihre vorhandenen Newsletter oder rufen Sie den vollständigen Inhalt eines bestimmten Newsletters anhand seiner ID ab.
c. Funnels und Seiten-Editor:
- Funnels verwalten: Neue Funnels erstellen, neue Schritte (Seiten) hinzufügen und eine Liste aller einzelnen Schritte innerhalb eines bestimmten Funnels abrufen.
- Seiten-Editor: Generierten Seiteninhalt direkt auf Ihre Funnel-Schritte oder Webseiten (vollständiger Ersatz) speichern und JSON-Schemata für spezifische Seitentypen abrufen.
d. Preispläne und Gutscheine:
- Erstellen, bearbeiten und löschen: Neue Preispläne und Gutscheine generieren oder bestehende teilweise aktualisieren und löschen.
- Auflisten und durchsuchen: Alle Ihre bestehenden Preispläne und Gutscheine durchsuchen oder spezifische Elemente anhand ihrer ID abrufen.
e. Kurse und Studenten:
- Kurse und Studenten verwalten: Eine Liste Ihrer vorhandenen Kurse abrufen und eine Liste der derzeit eingeschriebenen Studenten abrufen.
- Studenten anmelden: Kontakte in Ihre einzelnen Kurse programmgesteuert einschreiben.
Hinweis zu Kursen: Unterstützung für Kursbündel wird in zukünftigen Updates hinzugefügt.
f. Communities:
- Communities verwalten: Eine Liste Ihrer bestehenden Communities abrufen und eine Liste der aktuellen Mitglieder innerhalb einer bestimmten Community einsehen.
- Mitglieder einladen: Neue Benutzer programmgesteuert einladen, Ihren Communities beizutreten, indem Sie deren Kontakt-ID angeben.
g. Automatisierungsregeln:
- Regeln verwalten: Gängige Ereignisse und Aktionen programmgesteuert verbinden, vorhandene Regeln aktualisieren (z. B. eine Aktion ändern, während der Auslöser gleich bleibt) oder Regeln als gelöscht markieren (Soft Delete).
- Auflisten und abrufen: Auflisten und abrufen: Durchsuchen Sie Ihre Automatisierungsregeln oder rufen Sie eine bestimmte Regel anhand ihrer ID ab.
h. Abonnements:
- Abonnements verwalten: Eine Liste aller Ressourcen in einem Abonnement von Drittanbieterplattformen abrufen und ein Abonnement entweder sofort oder am Ende des Abrechnungszyklus kündigen.
i. Webhooks
- Webhooks verwalten: Programmgesteuert neue Webhooks erstellen, um Echtzeit-Benachrichtigungen zu erhalten, Listen Ihrer vorhandenen Webhooks abrufen und nicht mehr benötigte Webhooks entfernen.
Hinweise:
- Um Ihre Tokens einfach zu identifizieren und zu verwalten, muss jeder Token einen eindeutigen Namen haben.
- Ein Token kann nur direkt nach der Erstellung kopiert werden. Wenn Sie vergessen haben, Ihren Token zu kopieren, löschen Sie ihn und erstellen Sie einen neuen.
- Aus Sicherheitsgründen senden wir Ihnen eine E-Mail-Benachrichtigung, sobald ein neuer öffentlicher API-Schlüssel in Ihrem systeme.io-Konto erstellt wird.
- Sie können bis zu 3 API-Schlüssel pro Konto erstellen.
Erfahren Sie mehr: API-Dokumentation.