Das Abonnement für Sendungsverfolgungsnummern für Advanced Integrated Visibility ist für Abonnenten von Advanced Integrated Visibility vorgesehen, um ihre auf Sendungsverfolgungsnummern basierenden Webhook-Projekte zu verwalten und projektbezogene Vorgänge wie das Hinzufügen von neuen Sendungsverfolgungsnummern oder das Bearbeiten oder Anzeigen von Job-Details über API-Endpunkte durchzuführen.

Hinweis:

• Sie benötigen Administrator- oder Mitwirkendenzugriff für Ihr Advanced Integrated Visibility-Projekt
• Weitere Informationen zu Advanced Integrated Visibility und seinen Funktionen finden Sie auf der Seite Advanced Integrated Visibility – Dokumentation

Die Vorteile des Abonnements für die Sendungsverfolgungsnummer mit Advanced Integrated Visibility sind:

• Sie können die Sendungsverfolgungsnummern Ihres Advanced Integrated Visibility-Projekts ganz einfach über die API-Endpunkte aktualisieren und verwalten.
• Mit dieser API können Sie Ihrem Projekt mehrere Sendungsverfolgungsnummern in einer einzigen API-Transaktion zuordnen, anstatt jede Sendungsverfolgungsnummer einzeln zuzuordnen.
• Sie können API-Anfragen nacheinander senden und die Protokolldetails zu den Erfolgen/Fehlern dieser Anfragen anzeigen.

Verwenden Sie die folgenden Endpunkte, um Ihr Advanced Integrated Visibility-Projekt zu verwalten:

Der Zugriff auf diese API ist nur über Ihre Projektübersicht möglich, wie im obigen Screenshot dargestellt.

Verwenden Sie diesen Endpunkt, um einen asynchronen Job auszulösen, mit dem eine oder mehrere Sendungsverfolgungsnummern einem bestimmten Advanced Integrated Visibility-Projekt zugeordnet werden.

Die für diese Anfrage erforderlichen Eingabedaten sind:

• Aktion – Geben Sie die Aktion an, die beim Absenden der Anfrage ausgeführt werden soll. Beispiel: ADD
• Sendungsverfolgungsnummer – Bitte geben Sie die Sendungsverfolgungsnummer an

Sie können maximal 1.000 Sendungsverfolgungsnummer in einer einzigen Anfrage zusammenfassen. Die erfolgreiche Antwort auf diese Anfrage gibt die Job-ID, den aktuellen Jobstatus sowie den Zeitstempel für die Erstellung und Fertigstellung des Jobs zurück. Diese Job-ID kann später verwendet werden, um den Status des asynchronen Jobs zu überprüfen.

Verwenden Sie diesen Endpunkt, um den Status eines asynchronen Jobs (eine oder mehrere aufeinanderfolgende Anfragen in der Warteschlange) oder den Status aller übermittelten Jobs abzurufen.

Die für diese Anfrage erforderlichen Eingabedaten sind:

• Job-ID– Geben Sie die Job-ID an, für die Sie den Status abrufen möchten.

Hinweis: Die Job-ID ist eine optionale Eingabe für diesen Endpunkt. Wenn Sie die Job-ID nicht angeben, erhalten Sie den Status aller übermittelten Jobs.

Die erfolgreiche Antwort auf diese Anfrage gibt die Job-ID, den aktuellen Jobstatus sowie den Zeitstempel für die Erstellung und Fertigstellung des Jobs zurück. Die Antwort zeigt den aktuellen Status der Jobs an. Darüber hinaus enthält die Antwort auch Erfolgsmeldungen, Fehler oder Warnungen, die Benutzer anzeigen und gegebenenfalls beheben können.

• Wenn der Jobstatus als „ABGESCHLOSSEN“ angezeigt wird, bedeutet dies, dass alle Sendungsverfolgungsnummern validiert und erfolgreich verarbeitet wurden.
  • Der Status „ABGESCHLOSSEN“ bedeutet, dass die Sendungsverfolgungsnummern validiert und erfolgreich verarbeitet wurden. Dies bedeutet nicht, dass alle Sendungsverfolgungsnummern erfolgreich zum Advanced Integrated Visibility-Projekt hinzugefügt wurden.
  • Wenn Sie versuchen, mehrere Sendungsverfolgungsnummern zuzuordnen, und nur einige davon zugeordnet werden können, während die Zuordnung der übrigen fehlschlägt, wird der Jobstatus dennoch als „ABGESCHLOSSEN“ aktualisiert. Um den Status jeder Sendungsverfolgungsnummer in der zugehörigen Anfrage zu bestätigen, muss der Batch-Bericht heruntergeladen werden.

Hinweis:

• Wenn der Jobstatus als „FEHLGESCHLAGEN” angezeigt wird, bedeutet dies, dass die Anfrage aus verschiedenen Gründen/aufgrund schwerwiegender Fehler nicht verarbeitet werden konnte und der Benutzer sie erneut versuchen muss.

Nachfolgend finden Sie die Statusmeldungen und ihre jeweiligen Beschreibungen:

Verwenden Sie diesen Endpunkt, um einen JSON-Bericht für einen asynchronen Job im Status „ABGESCHLOSSEN“ herunterzuladen.

Die für diese Anfrage erforderlichen Eingabedaten sind:

• Job-ID– Geben Sie die Job-ID an, für die Sie den Status abrufen möchten.

Hinweis:

• Die Job-ID ist ein obligatorisches Eingabefeld für diesen Endpunkt.
• Sie können jeweils nur den Bericht eines asynchronen Jobs herunterladen.
• Wenn der Job nicht ABGESCHLOSSEN ist und Sie versuchen, den Bericht herunterzuladen, wird eine Fehlermeldung angezeigt.

Die erfolgreiche Antwort auf diese Anfrage liefert Ihnen den Bericht des Jobs im JSON-Format.

• Pro Anfrage können maximal 1.000 Sendungsverfolgungsnummern mit einem Advanced Integrated Visibility-Projekt verknüpft werden.
• Die Anzahl der Sendungsverfolgungsnummern, die Sie einem bestimmten Advanced Integrated Visibility-Projekt zuordnen können, ist unbegrenzt.
• Alle zugehörigen Sendungsverfolgungsnummern werden 40 Tage nach Abschluss eines bestimmten Advanced Integrated Visibility-Projekts gelöscht.
• Alle erstellten Job-ID-Status und -Details sind nach 90 Tagen für ein bestimmtes Advanced Integrated Visibility-Projekt nicht mehr verfügbar.
• Sichere Sendungsverfolgungsinformationen wie Empfängeradresse und Empfängersignatur sind über das Abonnement für die Sendungsverfolgungsnummer von Advanced Integrated Visibility nicht verfügbar.