API-Setup für Push-Benachrichtigungen
Übersicht
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. Einrichten von Push-Benachrichtigungen:
- Nachdem Sie sich bei TI.com angemeldet haben, klicken Sie auf das Dropdown-Menü neben dem Benutzernamen und wählen die Option „myTI-Dashboard“.
- Klicken Sie im myTI-Dashboard auf der linken Seite des Navigationsmenüs unter „Firmenkonto“ auf „API-Schlüssel und Zugriff“.
- Erweitern Sie den Abschnitt „TI Store API Suite“.
- Klicken Sie auf das Zahnrad-Symbol neben der Push-API, die Sie einrichten müssen.
Vorgehensweise zum Ausfüllen dieses Formulars:
API-URL: Ihre API-URL, die die POST-Anfragen von TI akzeptiert. TI-API-Push-Benachrichtigungen werden hier gesendet (in Ihrem spezifischen Screenshot, wenn ein ASN-Dokument erstellt wird).
Datenformat: Das Datenformat, das in der von der TI-API gesendeten POST-Anfrage empfangen werden soll (JSON oder XML, falls unterstützt). Das Standard‑Datenformat ist JSON.
Authentifizierungstyp: Wir unterstützen zwei Arten der Authentifizierung beim Aufruf Ihrer API:
- Die grundlegende Authentifizierung (bei der ein Benutzername und ein Passwort definiert werden, wie unten gezeigt) identifiziert einen bestimmten Benutzer.
- Token (bei dem sie uns einen geheimen Schlüssel geben, den die TI-API in einem bestimmten Header sendet) identifiziert eine bestimmte Anwendung.
API-Anfrageparameter: Hierbei handelt es sich um ein oder mehrere optionale Felder, in dem Sie Parameter definieren können, die die TI-API beim Aufruf Ihrer API berücksichtigen soll. Sie können z. B. das Datum um fünf Tage verschieben oder die Ergebnisse auf die ersten fünf Ergebnisse beschränken.
TI ist bestrebt, Ihre Systeme und die von TI vor Sicherheitsbedrohungen zu schützen, und verlangt, dass die Endpunkte der Kunden bestimmte Richtlinien zum Aktivieren der API-Rückruffunktion erfüllen. Ihre Push-API-Einstellungen im myTI-Dashboard sowie einzelne API-Aufrufe von TI an Ihre angegebenen Endpunkte werden überprüft, und der Zugriff auf die Push-APIs kann widerrufen werden, wenn die unten beschriebenen Best Practices nicht eingehalten werden.
- Verwenden Sie HTTPS-Webhook-URLs mit SSL-Verschlüsselung und einem gültigen Zertifikat.
- Die API sollte ein Sicherheitsschema implementieren, um den Zugriff einzuschränken. Die Token-Authentifizierungsmethode wird bevorzugt, jedoch wird bei Bedarf eine Standardauthentifizierung unterstützt.
- Verwenden Sie keine dynamischen DNS-, Redirector-, Anonymizer- oder tor2web-Dienste.
- Verwenden Sie keine beleidigenden, betrügerischen oder mit einem Embargo belegten Domains der obersten Ebene.
- Wenn möglich, sollte die Domäne Ihrer API-URL mit Ihrer myTI-Kundendomäne übereinstimmen.
- Verwenden Sie keine IP-Adressen.
- Verwenden Sie keine Umleitungs- oder Relais-URL-Parameter.
- Stellen Sie sicher, dass die Endpunkt-URL, die Sie in den myTI-API-Einstellungen speichern, externe Anfragen zulässt.
- Stellen Sie sicher, dass Ihre Firewall externe Anfragen zulässt.
- Endpunkte werden im JSON-Datenformat erwartet.
- Die „API-Anforderungsparameter“ sind optional und können verwendet werden, wenn Sie zusätzliche Einstellungen für API-Aufrufe an TI festlegen möchten.
Der Prozess zur Überprüfung und Genehmigung von API-Endpunkten und zur Sicherung der API-Callback-Funktionalität wird weiterentwickelt und verbessert, und wir danken Ihnen herzlich für Ihre Kooperation.