Mit der EchtPost-API v2 verbinden Sie EchtPost direkt mit Ihren eigenen Systemen – zum Beispiel Ihrem CRM, einem Online-Shop oder einer eigenen Kampagnen-Software. Fast alles, was Sie sonst in der Weboberfläche von EchtPost erledigen, lässt sich auch automatisch per Schnittstelle auslösen.
Was Sie mit der API v2 machen können
Kontakte und Gruppen verwalten
Empfänger anlegen, aktualisieren oder löschen. Kontakte lassen sich in Gruppen organisieren – zum Beispiel "Stammkunden" oder "Newsletter-Empfänger" – und später für Massensendungen verwenden.
Postkarten erstellen und versenden
Einzelne Karten oder ganze Serien anlegen, entweder mit einer zuvor gespeicherten Vorlage oder komplett frei konfiguriert. Empfänger können Sie flexibel übergeben: als einzelnen Kontakt, als Gruppe, als Liste mehrerer Kontakt-IDs oder direkt mit Adressdaten im Request.
Versandtermin planen
Sie müssen nicht sofort drucken lassen – geben Sie einfach ein gewünschtes Versanddatum mit, und die Karten gehen pünktlich raus.
Persönliche Anrede automatisch einfügen
Mit dem Platzhalter {anrede} im Kartentext wird für jeden Empfänger automatisch seine persönliche Anrede eingesetzt – ideal für personalisierte Serienmailings.
Textlängen-Prüfung vor dem Versand
Die API prüft, ob Ihr Kartentext in der gewählten Schriftart aufs Postkarten-Format passt, und schlägt bei Bedarf eine kleinere Schriftgröße vor. So gibt es keine bösen Überraschungen.
Vorlagen abrufen
Ihre in der Weboberfläche gespeicherten Vorlagen lassen sich über die API auflisten und direkt zum Erstellen neuer Karten verwenden.
Konto im Blick behalten
Kontostand und Preisinformationen jederzeit per API abfragen.
Karten stornieren
Noch nicht gedruckte Karten lassen sich über die API wieder abbestellen.
Zugang und Sicherheit
Für die Nutzung der API brauchen Sie einen API-Key, den Sie in Ihrem EchtPost-Account in den Account Einstellungen (Zahnrad rechts oben) und dann unter "API-Schlüssel zum Datenaustausch" selbst erstellen können. Der Key wird im Header jedes Requests mitgesendet (X-Api-Key oder Authorization: Bearer). Aus Sicherheitsgründen akzeptieren wir keine API-Keys in der URL.
Technische Details
Die vollständige technische Dokumentation mit allen Endpunkten, Beispielen und einem interaktiven API-Explorer finden Sie unter:
Dort können Sie Requests direkt ausprobieren, die OpenAPI-Spezifikation herunterladen und fertige Code-Beispiele zum Kopieren finden.