Technische Schnittstelle · Dokumentiert
Newsletter-Software mit REST API
Die dokumentierte mailfino REST API verbindet eigene Systeme und kontrollierte Automatisierungen mit Empfängern, Listen, Formularen, Entwürfen und Versandprozessen.
GET /api/v6/recipients
Authorization: Bearer …
Accept: application/json
Ein kontrollierter Datenfluss
Eigene Systeme mit dokumentierten mailfino-Ressourcen verbinden
Die API ist kein pauschales Versprechen für jede denkbare Integration. Sie ist die technische Grundlage, um einen klar definierten Datenfluss mit passenden Ressourcen und Berechtigungen umzusetzen.
Daten bereitstellen
CRM, Fachsoftware, Portal oder eigener Dienst liefert die für den Prozess vorgesehenen Daten.
Ressourcen gezielt nutzen
Bearer Token, dokumentierte Endpunkte und definierte Feldzuordnungen bilden den technischen Vertrag.
Kontakte und Abläufe verbinden
Empfänger, Listen, Formulare, Inhalte oder Versandaufträge werden im vorgesehenen Kontext verarbeitet.
Dokumentierte Bereiche
Newsletter-Prozesse über klar benannte Ressourcen anbinden
Swagger UI und OpenAPI-Spezifikation beschreiben den technischen Umfang der API-Version v6. Welche Ressourcen ein Projekt tatsächlich benötigt, ergibt sich aus dem gewünschten Arbeitsablauf.
Kontakte verwalten
Empfänger anlegen, abrufen und im vorgesehenen Account-Kontext bearbeiten.
Listen, Felder und Tags
Kategorien, Felder, Tags, Importe und Abfragen für strukturierte Zielgruppenprozesse nutzen.
Eingaben weiterverarbeiten
Formulare und dokumentierte Formulareingaben in kontrollierte Folgeprozesse einbeziehen.
Entwürfe und Vorlagen
Entwürfe, Vorlagen, Ordner und Versionen im dokumentierten Umfang ansprechen.
Jobs einordnen
Versandjobs im Zusammenhang mit Account, Empfängern und vorbereiteten Inhalten verwenden.
Abmeldungen und Beschwerden
Dokumentierte Rückmeldungen fachlich korrekt in angebundene Prozesse einordnen.
Typische Einsatzwege
Die API unterstützt konkrete Abläufe, nicht nur abstrakten Datenaustausch
Kontakte aus einem Fachsystem bereitstellen
Ausgewählte Kontaktdaten und Felder in einen nachvollziehbaren mailfino-Empfängerprozess überführen.
Listen und Zielgruppen aktuell halten
Strukturen aus dem Ausgangssystem mit Kategorien, Feldern oder Tags in mailfino abbilden.
Formulare in Folgeprozesse einbinden
Dokumentierte Formulareingaben dort weiterverwenden, wo ein definierter Prozess dies vorsieht.
Inhalte und Versandabläufe vorbereiten
Entwürfe, Vorlagen und Jobs nur mit den dafür vorgesehenen Ressourcen und Berechtigungen ansprechen.
Authentifizierung und Einrichtung
Bearer Token, API v6 und ein definierter Account-Kontext
Vor der Umsetzung werden Ausgangssystem, Zielressourcen, Feldzuordnung und benötigte Rechte geklärt. Produktive Zugangsdaten gehören ausschließlich in eine geschützte Serverkonfiguration.
- Swagger UI und OpenAPI JSON als technische Referenz
- Dokumentierte Endpunkte unter
/api/v6/ - Authentifizierung mit Bearer Token
- Keine Tokens in Browsercode, Beispieltexten oder öffentlichen Repositories
- Tests zunächst mit nicht produktiven Daten und begrenztem Umfang
Sicherheit und fachliche Grenzen
API-Zugriff ersetzt weder Einwilligungsprüfung noch Prozessverantwortung
Technisch übertragbare Daten dürfen nicht automatisch für Newsletter verwendet werden. Versandberechtigung, Datenminimierung, Löschkonzept und organisatorische Zuständigkeit bleiben Teil des konkreten Einsatzes.
Versandgrundlage getrennt prüfen
Ein vorhandener Kontakt oder erfolgreicher Import ist keine pauschale Newsletter-Einwilligung.
Nur benötigte Felder übertragen
Der Datenfluss sollte auf die für den dokumentierten Prozess erforderlichen Daten begrenzt werden.
Fehler und Änderungen behandeln
Integrationen benötigen Protokollierung, kontrollierte Wiederholungen und Pflege bei geänderten Datenmodellen.
Cloud und Selfhosting
Die Schnittstelle in das passende Betriebsmodell einordnen
Ob die API in der mailfino Cloud oder in einer selbst betriebenen Installation genutzt wird, beeinflusst Basis-URL, Zugang, Betrieb und Verantwortlichkeiten.
API im betriebenen mailfino-Account
mailfino betreibt die Plattform; das angebundene System nutzt die für den Account vorgesehenen Zugangsdaten und Endpunkte.
API in der eigenen Umgebung
Basis-URL, Erreichbarkeit, TLS, Updates und Monitoring gehören zur selbst verantworteten Infrastruktur.
FAQ
Fragen zur mailfino Newsletter API
Wie ist die REST API dokumentiert?
mailfino stellt eine Swagger UI und eine OpenAPI-Spezifikation für die dokumentierte API-Version v6 bereit.
Wie erfolgt die Authentifizierung?
Die öffentliche API-Dokumentation verwendet Bearer-Token-Authentifizierung. Tokens müssen serverseitig und geschützt gespeichert werden.
Welche Bereiche lassen sich ansprechen?
Dokumentiert sind unter anderem Empfänger, Kategorien, Felder, Tags, Importe, Formulare, Entwürfe, Vorlagen, Jobs, Abmeldungen und Beschwerden. Maßgeblich bleibt die Swagger-Dokumentation.
Kann ein Browser direkt mit dem Bearer Token arbeiten?
Produktive Tokens sollten nicht in öffentlich ausgeliefertem Browsercode stehen. Ein angebundener Serverdienst ist der kontrollierbare Integrationspunkt.
Ist ein importierter Kontakt automatisch versandberechtigt?
Nein. Technische Übertragung und rechtliche Versandberechtigung sind getrennte Fragen.
Ist die API für Cloud und Selfhosting geeignet?
Der konkrete Einsatz wird nach Produktvariante, Basis-URL, Account-Kontext, Berechtigungen und gewünschtem Datenfluss eingeordnet.
Werden öffentliche Rate Limits zugesagt?
Nein. Konkrete technische Rahmenbedingungen werden für den jeweiligen Produkt- und Projektkontext geklärt.
Technischen Bedarf klären
Welcher Datenfluss soll über die API entstehen?
Beschreiben Sie Ausgangssystem, Ressourcen, Richtung des Datenflusses und Betriebsmodell. Wir gleichen die Anforderung mit dem dokumentierten API-Umfang ab.