API sendet E-Mail-Benachrichtigungen bei Fehlern

Hinweis: Folgender Artikel richtet sich primär an portatour®-Administratoren von Firmenzugängen (2 oder mehr Benutzern).

Schon sehr viele Unternehmen nutzen die API von portatour® Anywhere zum regelmäßigen automatischen Importieren und Exportieren von Daten. Das freut uns natürlich sehr.

Wir haben allerdings im Zuge von Logfile-Analysen festgestellt, dass in manchen Fällen keine Ursachenbehebung bei fehlerhaften API-Aufrufen stattfindet. D.h. dieselben fehlerhaften Aufrufe werden täglich wieder und wieder erfolglos versucht.

Durch diese Fehler, die häufig durch Dateninkonsistenzen in der Importdatei begründet sind, schlägt der API-Aufruf gänzlich fehl. Der Außendienstmitarbeiter erhält keine aktuellen Daten. Oft wird das Problem erst nach Tagen oder Wochen durch Reklamation des Benutzers selbst identifiziert und behoben.

Mit dem heutigen Update der portatour® API schaffen wir Abhilfe, damit in Zukunft Fehler schnell erkannt und gelöst werden, bevor Benutzer betroffen sind.

Wenn ein API-Aufruf fehlschlägt, wird durch portatour® automatisch eine E-Mail mit einer genauen Aufruf- und Fehlerbeschreibung an die E-Mail-Adresse jenes Administratorkontos gesendet, dessen Anmeldedaten für den API-Aufruf verwendet wurden. Sie als Administrator können zeitnah mit der Ursachenbehebung beginnen. Stellen Sie unbedingt sicher, dass beim verwendeten Administratorkonto eine korrekte E-Mail-Adresse eingetragen ist, dessen Postfach auch gelesen wird.

Hinweis: Um bei Fehlern, die viele Benutzerkonten und somit viele API-Aufrufe betreffen, keine Flut an E-Mails zu generieren, erfolgt der automatische E-Mail-Versand nach einem fehlerhaften API-Aufruf immer zumindest eine Minute verzögert. Wenn in dieser Minute weitere fehlerhafte API-Aufrufe passieren, werden alle Fehlermeldungen in eine einzige Mail zusammengefasst und der E-Mail-Versand weiter verzögert. Wundern Sie sich daher nicht, warum E-Mails im Fehlerfall immer zumindest eine Minute verzögert in Ihrem Postfach eintreffen.

Wir möchten Sie an dieser Stelle gleich beruhigen: Meist geht es darum, Sonderfälle in den Daten oder im Ablauf, die bei der anfänglichen Programmierung der Datensynchronisation mittels der API noch nicht bekannt waren, einmalig in Ihrem Programmcode bzw. Prozess abzubilden. Danach sollten die API-Aufrufe dauerhaft fehlerfrei durchlaufen.

Der automatische E-Mail-Versand bei Fehlern ist nicht deaktivierbar. Es sollte immer das Ziel sein, die Ursache des Fehlers zu beheben, da ansonsten der API-Aufruf ohnehin fehlschlägt.

Bitte berücksichtigen Sie, dass die E-Mail-Benachrichtigung viele der möglichen Fehler in der Automatisation abdeckt, allerdings nicht allumfassend ist. Zum Beispiel erfolgt bei folgenden zwei Problemszenarien keine E-Mail durch portatour®:

  • Wenn Sie ungültige Administratorzugangsdaten (Benutzername + Passwort) beim API-Aufruf verwenden. portatour® kann dadurch Ihre E-Mail-Adresse nicht identifizieren.
  • Wenn auf Ihrer Seite bereits in einem Vorverarbeitungsschritt ein Fehler auftritt und der Programmfluss gar nicht zum eigentlichen API-Aufruf weiterläuft.

Sollten Sie generell Unterstützung bei der API-Nutzung benötigen, bieten wir gerne einen individuellen Workshop dazu an.