Guides API

API

Mit der Heymail API automatisieren Sie den Versand personalisierter Postkarten in Ihren bestehenden Systemen, zum Beispiel für CRM-Prozesse, Shop-Trigger, Lifecycle-Kampagnen oder eigene Marketing-Tools.

Visualisierung der Heymail API mit personalisierten Daten und Postkarte

So verbinden Sie Daten aus Ihrem System direkt mit einem Postkarten-Mailing, zum Beispiel für Namen, Gutscheincodes oder andere variable Inhalte.

Funktionen im Überblick

Mit der Heymail API können Sie gedruckte Postkarten programmgesteuert versenden, einzeln oder in größeren Mengen.

Einzel- & Massenversand

Versenden Sie eine einzelne Postkarte oder bis zu 10.000 Postkarten mit einer Anfrage an Ihre Empfänger.

Personalisierung

Jede Postkarte kann individualisiert werden, z. B. mit Anrede, Gutscheincode, Bestellnummer oder QR-Code.

Vorschau

Rufen Sie vor dem Versand eine Vorschau der Postkarte ab. Es wird kein Druckauftrag erstellt und es entstehen keine Kosten.

Templates aus der Web-App

Templates werden in der Heymail Web-App angelegt und bearbeitet. Über die API übergeben Sie anschließend nur die Inhalte, z. B. Namen oder Codes.

Test- und Live-Keys

Mit Test-Keys können Sie die API ohne echten Versand verwenden. Live-Keys lösen den tatsächlichen Versand aus.

Aufträge & Rechnungen

Aufträge und Rechnungen können jederzeit in der Heymail Web-App eingesehen werden.

Dokumentation

So funktioniert's

Für den ersten erfolgreichen Request brauchen Sie nur wenige Schritte: API-Key, Template und einen ersten Test-Request.

  1. API-Key anlegen: Legen Sie Ihren API-Key in Heymail unter API verwalten an.
  2. Template anlegen: Erstellen Sie Ihr Template in Heymail, speichern Sie es und kopieren Sie anschließend die templateId. Diese ID verwenden Sie später in Ihren Requests. Unter Vorlagen finden Sie Ihre angelegten Templates.
  3. API aufrufen: Starten Sie zuerst mit einer Vorschau und senden Sie erst danach produktiv.
    • Vorschau: Rufen Sie /mailings/preview mit einem Test-Key auf, um Template und variable Daten zu prüfen.
    • Send: Rufen Sie /mailings/send zunächst mit einem Test-Key und später mit einem Live-Key auf.

API aktivieren

Der Zugang zur Heymail API wird individuell pro Account freigeschaltet. Sie erhalten von uns einen persönlichen API-Key, mit dem Ihre Anfragen authentifiziert werden.

  1. Heymail-Account anlegen: Falls noch nicht vorhanden, registrieren Sie sich hier kostenlos.
  2. API-Zugang anfragen: Nehmen Sie über unser Kontaktformular Kontakt mit uns auf und geben Sie kurz an, was Sie automatisieren möchten, z. B. Shop-Anbindung, CRM-Trigger oder Kampagnen-Versand.
  3. Freischaltung erhalten: Wir schalten den Zugang frei und senden Ihnen die nächsten Schritte für die Nutzung der API.

Haben Sie weitere Fragen?
Bitte nehmen Sie mit uns Kontakt auf, wir stehen Ihnen gerne zur Verfügung.

Support kontaktieren