Transaktionale API-Methoden sind für alle Service-Kunden auf bezahlten Tarifplänen verfügbar, die ihre eigene Absender-Domains (DKIM&SPF) im Bereich "Mein Account"=>"Meine Domains" konfiguriert haben.
Während der Probezeit ist es auch möglich, diese API auf Anfrage zu testen. Wenn Sie Zugriff benötigen, schreiben Sie uns direkt an support@gestaltplatform.com.
Die Arbeit mit der API erfolgt durch Senden von HTTP-Anfragen (GET, POST-Methoden) an die Adresse:
api.gestaltmail.com
Verwenden Sie HTTP- oder HTTPS-Protokolle. Codierung: UTF-8.
Die Autorisierung erfolgt entweder durch den Parameter api_key oder durch die Parameter Benutzername und Passwort. Verwenden Sie zum Senden von Nachrichten die Methode transactional.send .
http://api.gestaltmail.com/?method=transactional.send&api_key=88854bb15344453a0193df0a4acbe793 &format=xml&to=test@mymail.com&message=<p>test message=</p>&headers= a:2:{s:4:"From";s:22:""test" =<admin@mailerloop.com>";s:7:"Subject";s:4:"test";}
api_key Parameter kann man im Bereich "Integrationen"=>"Transaktion-Mailings in Account generieren.
Die Antwort kann in einem von mehreren Formaten sein. Um es zu setzen, benutzen Sie den Parameter format:
GestaltMail gibt strukturierte Daten wie folgt zurück:
An jede E-Mail können Sie so viele Dateien wie möglich mit einem Gesamtvolumen von bis zu 5 MB anhängen. Alle Dateien außer *. exe und *. php sind erlaubt. Sie sollten alle spezielle Zeichen einschließlich Satzzeichen und Prozentzeichen in Dateinamen vermeiden. Dateien werden standardmäßig in der Post-Anfrage gesendet. Wichtig! Der Parameter Name muss ein Array mit dem Namenattachments sein. Wenn Sie z. b. eine Anfrage mit cURL senden, sieht Sie wie folgt aus:
Selbst wenn die angehängte Datei nur eine ist, sollte Sie in $post[‘attachments[0]’], und nicht in $post[‘attachments’] übergeben werden.
Berichte über verschiedene Ereignisse, die mit gesendeten Nachrichten auftreten, werden in Form von Webhooks implementiert. Im Bereich "Integrationen"=>"Transaktion-Mailings" können Sie die Script-Adressen angeben, die beim Auftreten bestimmter Ereignisse aufgerufen werden (Rücksendung, Spambeschwerde oder Nichtzustellung).
Wenn ein Ereignis auftritt, wird eine POST-Anfrage mit Informationen über das Ereignis an die angegebene Adresse gesendet.
Zusätzlich können folgende Parameter übertragen werden:
Wenn z. B. eine Rückgabe nach mehreren Zustellungsversuchen aufgetreten ist, wird $_POST['reason'] auf 'old' festgelegt, und wenn es einen eindeutigen Grund für die Rückgabe gibt, dann auf 'Hardfail'. Der Fehlercode selbst wird in $_POST['description'] enthalten sein. In der Regel, Fehlercodes, die mit ‘5’ beginnen, beziehen sich auf Hard Bounce (E-Mail nicht existiert oder blockiert ist). Und Fehlercodes, die mit “4” beginnen, sind Soft Bounces (vorübergehende Unmöglichkeit der Lieferung). Wenn man die E-Mail als Spam anzeigt, wird der 9.9.9-Code am häufigsten zurückgegeben.
Wenn Sie Probleme mit der Integration haben oder glauben Sie, dass die API-Methode nicht richtig funktioniert, bitte schreiben Sie an support@gestaltplatform.com und unsere Entwickler und Support-Team werden Sie schnell antworten.
