Het op tracking-nummer gebaseerde abonnement voor Advanced Integrated Visibility is ontworpen voor abonnees van Advanced Integrated Visibility om hun webhookprojecten op basis van tracking-nummer te beheren en projectgerelateerde bewerkingen uit te voeren, zoals het toevoegen van nieuwe tracking-nummers, het bewerken of bekijken van taakgegevens met behulp van API-eindpunten.

Opmerking:

• U moet toegang als beheerder of bijdrager hebben voor uw Geavanceerde geïntegreerde zichtbaarheid-project
• Ga naar de pagina Documentatie over Geavanceerde geïntegreerde zichtbaarheid voor meer informatie over Geavanceerde geïntegreerde zichtbaarheid en zijn functies.

De voordelen van op trackingnummer gebaseerde abonnementen voor Geavanceerde geïntegreerde zichtbaarheid zijn:

• U kunt uw Geavanceerde geïntegreerde zichtbaarheid-project eenvoudig bijwerken en beheren met behulp van de API-eindpunten.
• Deze API stelt u in staat om meerdere trackingnummers te koppelen aan uw project in een enkele API-transactie, in plaats van elk trackingnummer een voor een te koppelen.
• U kunt uw API-verzoeken opeenvolgend indienen en in de logboeken zien of deze verzoeken zijn gelukt/mislukt.

Gebruik de onderstaande eindpunten om uw Geavanceerde geïntegreerde zichtbaarheid-project te beheren:

Deze API kan alleen worden geopend via uw projectoverzicht zoals u in de schermafbeelding hierboven kunt zien.

Gebruik dit eindpunt om een asynchrone taak te activeren om een of meerdere trackingnummers te koppelen aan een specifiek Geavanceerde geïntegreerde zichtbaarheid-project.

De vereiste invoerinformatie voor dit verzoek is:

• Actie – Bepaal welke actie moet worden uitgevoerd wanneer u het verzoek indient. Voorbeeld: ADD
• Trackingnummergegevens – Geef het trackingnummer op

U kunt maximaal 1.000 trackingnummers in een enkel verzoek koppelen. De succesvolle respons voor dit verzoek zal de jobID, de huidige taakstatus en de taakcreatie en de taakvoltooiingstijdstempel retourneren. Deze jobID kan later worden gebruikt om de status van de asynchrone taak te controleren.

Gebruik dit eindpunt om de status van een asynchrone taak (een of meer opeenvolgende verzoeken in de wachtrij) of de status van alle ingediende taken op te halen.

De vereiste invoerinformatie voor dit verzoek is:

• Taak-ID – Geef de taak-ID op waarvan u de status wilt ophalen.

Let op: de taak-ID is een optionele invoer voor dit eindpunt. Als u de taak-ID niet opgeeft, dan krijgt u de status van alle ingediende taken.

De succesvolle respons voor dit verzoek zal de jobID, de huidige taakstatus en de taakcreatie en de taakvoltooiingstijdstempel retourneren. De respons zal de huidige status van de taken weergeven. De respons zal ook de succesberichten, fouten of waarschuwingen voor gebruikers bevatten die ze kunnen bekijken en oplossen, indien van toepassing.

• Als de taakstatus wordt weergegeven als VOLTOOID, dan betekent dat dat alle trackingnummers zijn gevalideerd en verwerkt.
  • De status VOLTOOID geeft aan dat de trackingnummers zijn gevalideerd en verwerkt. Het betekent niet dat alle trackingnummers zijn toegevoegd aan het Geavanceerde geïntegreerde zichtbaarheid-project.
  • Zelfs als u probeert om meerdere trackingnummers te koppelen en alleen enkele van die trackingnummers worden gekoppeld, dan zal de taakstatus worden bijgewerkt naar VOLTOOID. Om de status van elk trackingnummer in het gekoppelde verzoek te bevestigen, moet u het batchrapport downloaden.

Opmerking:

• Als de taakstatus wordt weergegeven als MISLUKT, dan geeft dat aan dat vanwege verschillende redenen/fouten het verzoek niet kon worden verwerkt en de gebruiker het opnieuw moet proberen.

Hieronder staan de verschillende statussen en hun respectievelijke beschrijvingen:

Gebruik dit eindpunt om het JSON-rapport voor een asynchrone taak met de status VOLTOOID te downloaden.

De vereiste invoergegevens die bij dit verzoek horen, zijn:

• Taak-ID – Geef de taak-ID op waarvan u de status wilt ophalen.

Opmerking:

• De taak-ID is een verplichte invoer voor dit eindpunt.
• U kunt het rapport maar voor één asynchrone taak per keer downloaden.
• Als de taak niet VOLTOOID is en u het rapport probeert te downloaden, dan zal er een foutbericht worden weergegeven.

De succesvolle respons voor dit verzoek geeft u het rapport van de taak in JSON-indeling.

• Er kunnen maximaal 1.000 verzendtrackingnummers worden gekoppeld aan een Geavanceerde geïntegreerde zichtbaarheid-project in elk verzoek.
• Er is geen limiet voor het maximale aantal trackingnummers dat u kunt koppelen met een bepaald Geavanceerde geïntegreerde zichtbaarheid-project.
• Elk gekoppelde trackingnummer wordt na 40 dagen ontkoppeld van het bijbehorende Geavanceerde geïntegreerde zichtbaarheid-project.
• Elke status en gegevens van de gemaakte taak-ID zullen na 90 dagen niet meer beschikbaar zijn voor het bijbehorende Geavanceerde geïntegreerde zichtbaarheid-project.
• Beveiligde trackinginformatie zoals het adres van de ontvanger, de handtekening van de ontvanger, zal niet beschikbaar zijn via het op trackingnummer gebaseerde abonnement voor Geavanceerde geïntegreerde zichtbaarheid.