API-Setup für Push-Benachrichtigungen

Überblick

Wir bieten mehrere Push-APIs an, mit denen Sie detaillierte Informationen abrufen können, sobald diese verfügbar sind, z. B. Informationen zur Verfügbarkeit, zum Versand und zu Finanzdaten. Diese APIs können in die Automatisierungsprozesse der Kunden integriert werden.

Befolgen Sie diese Schritte, um Push-Benachrichtigungen einzurichten: 

  1. Zugriff auf Ihr Dashboard: Melden Sie sich bei Ihrem Konto an und navigieren Sie im Dropdown-Menü „Benutzer“ zum myTI-Dashboard.
  2. API-Schlüssel und -Zugriff: Gehen Sie im myTI-Dashboard zum Navigationsmenü und wählen Sie unter „Firmenkonto“ die Option „API-Schlüssel und Zugriff“.
  3. Wählen Sie Ihre Push-API: Erweitern Sie den Bereich "TI Store API Suite". Wählen Sie das Zahnradsymbol neben der konkreten Push-API, die Sie aktivieren möchten.

 


Vorgehensweise zum Ausfüllen dieses Formulars

In dieser Anleitung wird erläutert, wie Sie Push-Benachrichtigungen für ASN-Dokumente (Versandvorabmitteilungen) konfigurieren.

API-URL:

  • Geben Sie die URL Ihres API-Endpunkts ein, der POST-Anfragen empfangen kann.
  • An diese URL werden TI-API-Push-Benachrichtigungen gesendet (in Ihrem konkreten Screenshot: wenn ein ASN-Dokument erstellt wird).

Datenformat:

  • Wählen Sie das Datenformat, das in der von der TI-API gesendeten POST-Anfrage empfangen werden soll (JSON oder XML, falls unterstützt).
  • Der Standard ist JSON.

Authentifizierungstyp:

Wir unterstützen zwei Authentifizierungsmethoden:

  • Standardauthentifizierung: Geben Sie einen Benutzernamen und ein Kennwort ein, um einen bestimmten Benutzer zu identifizieren.
  • Authentifizierung mit Token: Geben Sie uns einen geheimen Schlüssel, den die TI-API in einem bestimmten Header sendet, um Ihre Anwendung zu identifizieren.

API-Anforderungs-Parameter (optional): 

  • Sie können optionale Parameter für die TI-API definieren, die beim Aufruf Ihres Endpunkts enthalten sein sollen.

Sicherheitsanforderungen

TI ist bestrebt, sowohl Ihre als auch unsere Systeme vor Sicherheitsbedrohungen zu schützen. Deshalb müssen Ihre API-Endpunkte spezifische Richtlinien erfüllen:

  • Verwenden Sie HTTPS-Webhook-URLs mit SSL-Verschlüsselung und einem gültigen Zertifikat.
  • Implementieren Sie ein Sicherheitsschema, um den Zugriff zu beschränken. Wir empfehlen die Authentifizierung mit Token, aber auch die Standardauthentifizierung wird unterstützt.
  • Vermeiden Sie Folgendes:
    • Verwenden Sie kein dynamisches DNS, Umleitungen, Anonymizer oder Tor2web-Dienste.
    • Anstößige, beleidigende, betrügerische  oder mit einem Embargo belegte Domains der obersten Ebene
    • IP-Adressen
    • URL-Parameter für Umleitung oder Weiterleitung
  • Passen Sie Ihre API-URL-Domäne wenn möglich Ihrer myTI-Kundendomäne an.
  • Stellen Sie sicher, dass Ihre Firewall externe Anfragen an Ihre Endpunkt-URL zulässt.

Datenformat

Unsere API sendet Daten im JSON-Format.

Kontinuierliche Verbesserung

Wir arbeiten kontinuierlich daran, den Prozess zur Überprüfung und Genehmigung von API-Endpunkten zu verbessern. Wir danken Ihnen für Ihre Mithilfe beim Aufrechterhalten einer sicheren Umgebung.