API für E-Mail-Marketingdienste

Diese API wurde zur Integration externer E-Mail-Dienste entwickelt. Sie ermöglicht das Verwalten von Mailinglisten und Kontakten über einen einzigen Endpunkt (z. B. https://yourserver.com/planfix_integration.php) und akzeptiert Anfragen im JSON-Format.

Nachdem Sie die Integration implementiert haben, können Sie unseren Support-Service kontaktieren, damit Ihr Dienst in die Liste der in der Planfix-Oberfläche für Benutzer verfügbaren Integrationen aufgenommen wird.

Verbindung zu Planfix

• Gehen Sie zu Kontoverwaltung — Integrationen — E-Mail-Marketing, um die Integration zu verbinden und zu konfigurieren.
• Wählen Sie in dem geöffneten Bereich ganz unten Planfix API aus.
• Es öffnet sich ein Fenster mit den Integrationseinstellungen.
• Sie müssen die Adresse angeben, an die Planfix die Anfragen senden soll, und den API-Key für die Autorisierung.

Anforderungsformat

Die Anfrage wird per POST-Methode im JSON-Format an die in den Integrationseinstellungen angegebene Adresse gesendet.

Anfragebeispiel:

{
  "action": "action",
  "authToken": "your_authorization_token",
  "data": {
    // Data depending on the action
  }
}

Anfrageparameter:

Name	Beschreibung	Typ/Datentyp	Hinweis
action	Die auszuführende Aktion	string
authToken	Autorisierungstoken für den API-Zugriff	string
data	Daten abhängig von der Aktion	object

Unterstützte Aktionen

• createList — eine Mailingliste erstellen
• deleteList — eine Mailingliste löschen
• importContacts — Kontakte in eine Liste importieren
• updateContact — Kontakt aktualisieren

createList — Mailingliste erstellen

Beschreibung: Erstellt eine neue Mailingliste mit dem angegebenen Namen.

Anfrage:

{
  "action": "createList",
  "authToken": "your_authorization_token",
  "data": {
    "listName": "List name"
  }
}

'Antwort (Erfolg):

{
  "success": true,
  "listId": "unique_list_identifier""
}

Antwort (Fehler):

{
  "error": "Fehlerbeschreibung"
}

deleteList — Mailingliste löschen

Beschreibung: Löscht eine Mailingliste anhand ihrer Kennung.

Anfrage:

{
  "action": "deleteList",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier"
  }
}

Antwort (Erfolg):

{
  "success": true
}

Antwort (Fehler):

{
  "error": "Fehlerbeschreibung"
}

importContacts — Kontakte in eine Liste importieren

Beschreibung: Importiert Kontakte in die angegebene Mailingliste.

Anfrage:

{
  "action": "importContacts",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Name",
        "lastName": "Last name"
      }
    ]
  }
}

Antwort (Erfolg):

{
  "success": true
}

Antwort (Fehler):

{
  "error": "Fehlerbeschreibung"
}

updateContact — Kontakt aktualisieren

Beschreibung: Aktualisiert einen Kontakt in der Mailingliste. Unterstützt Aktionen: add, update, delete.

Anfrage:

{
  "action": "updateContact",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "action": "add|update|delete",
    "contact": {
      "id": 123,
      "email": "email@example.com",
      "firstName": "First name",
      "lastName": "Last name"
    },
    "oldEmail": "old_email@example.com" // nur für action=update
  }
}

Antwort (Erfolg):

{
  "success": true
}

Antwort (Fehler):

{
  "error": "Fehlerbeschreibung"
}

Wichtig

• Alle Antworten müssen im JSON-Format zurückgegeben werden.
• Im Fehlerfall muss immer das Feld "error" mit einer Beschreibung des Fehlers vorhanden sein.
• Im Erfolgsfall muss immer das Feld "success": true vorhanden sein.
• Die Autorisierung erfolgt über das Feld "authToken" in jeder Anfrage.
• Alle Textfelder müssen in UTF-8 kodiert sein.

Gehe zu

• API