Den spårningsnummerbaserade Advanced Integrated Visibility-prenumerationen är utformad för att Advanced Integrated Visibility-prenumeranter ska kunna hantera sina spårningsnummerbaserade webhookprojekt. De kan utföra projektrelaterade åtgärder som att lägga till nya spårningsnummer och redigera eller visa jobbinformation med hjälp av API-slutpunkter.

OBS!

• Du måste ha administratörs- eller deltagaråtkomst till Advanced Integrated Visibility-projektet.
• Mer information om Advanced Integrated Visibility och dess funktioner finns på sidan Dokumentation för Advanced Integrated Visibility.

Här följer fördelarna med Advanced Integrated Visibility Tracking Number Subscription:

• Du kan enkelt uppdatera och hantera spårningsnummer i ditt Advanced Integrated Visibility-projekt med hjälp av API-slutpunkterna.
• Det här API:et gör att du kan koppla flera spårningsnummer till ditt projekt i en och samma API-transaktion, i stället för att koppla varje spårningsnummer var för sig.
• Du kan skicka flera API-begäranden i rad och visa logguppgifter avseende lyckade/misslyckade begäranden.

Använd följande slutpunkter för att hantera ditt Advanced Integrated Visibility-projekt:

Du kan endast komma åt det här API:et via din projektöversikt, så som visas i skärmbilden ovan.

Använd den här slutpunkten för att utlösa ett asynkront jobb och koppla ett eller flera spårningsnummer till ett specifikt Advanced Integrated Visibility-projekt.

De nödvändiga uppgifterna som är associerade med begäran är:

• Åtgärd – specificera åtgärden som ska utföras när du skickar begäran. Exempel: LÄGG TILL.
• Uppgifter om spårningsnummer – specificera spårningsnumret.

Du kan koppla max. 1 000 spårningsnummer i en och samma begäran. Ett lyckat svar för den här begäran kommer att returnera jobb-ID, aktuell jobbstatus och tidsstämpel för jobbets skapande och slutförande. Det här jobb-ID:t kan användas för att kontrollera det asynkrona jobbets status vid ett senare tillfälle.

Använd den här slutpunkten för att visa statusen för ett asynkront jobb (en eller flera begäranden i rad i kö) eller status för alla inskickade jobb.

De nödvändiga uppgifterna som är associerade med begäran är:

• Jobb-ID  – specificera jobb-ID:t som du vill hämta statusen för.

Obs! Jobb-ID är valfria indata för den här slutpunkten. Om du inte specificerar jobb-ID:t visas statusen för alla inskickade jobb.

Ett lyckat svar för den här begäran kommer att returnera jobb-ID, aktuell jobbstatus och tidsstämpel för jobbets skapande och slutförande. Svaret kommer att visa aktuell status för jobben. Svaret kommer dessutom att innehålla meddelanden om lyckade åtgärder, fel eller varningar som användarna kan visa och felsöka efter behov.

• Om jobbstatusen är SLUTFÖRT innebär det att alla spårningsnummer har validerats och bearbetats.
  • Statusen SLUTFÖRT innebär att spårningsnumren har validerats och bearbetats. Det innebär inte att alla spårningsnummer har lagts till i Advanced Integrated Visibility-projektet. 
  • Jobbstatusen kommer att uppdateras till SLUTFÖRT även om bara vissa spårningsnummer kopplas när du försöker koppla flera spårningsnummer. Batchrapporten måste laddas ner för att bekräfta statusen för varje spårningsnummer i kopplingsbegäran.

OBS!

• Om jobbstatusen är SLUTFÖRT innebär det att begäran inte kunde bearbetas på grund av olika orsaker/fel och att användaren måste försöka igen.

Här följer en översikt över de olika statusarna och beskrivningar av dem:

Använd den här slutpunkten för att ladda ner JSON-rapporten för ett asynkront jobb med statusen SLUTFÖRT.

De nödvändiga uppgifterna associerade med denna begäran är:

• Jobb-ID  – specificera jobb-ID:t som du vill hämta statusen för.

OBS!

• Jobb-ID är obligatoriska indata för den här slutpunkten.
• Du kan endast ladda ner rapporten för ett asynkront jobb åt gången.
• Ett felmeddelande kommer att visas om du försöker att ladda ner rapporten för ett jobb som inte har statusen SLUTFÖRT.

Ett lyckat svar för den här begäran kommer att tillhandahålla rapporten för jobbet i JSON-format.

• Maximalt 1 000 spårningsnummer kan kopplas till ett Advanced Integrated Visibility-projekt i varje begäran.
• Det finns ingen begränsning av maximalt antal spårningsnummer som du kan koppla till ett specifikt Advanced Integrated Visibility-projekt.
• Alla kopplade spårningsnummer kommer att kopplas bort från ett specifikt Advanced Integrated Visibility-projekt efter 40 dagar.
• Status och uppgifter för eventuella skapade jobb-ID:n kommer inte att vara tillgängliga för ett specifikt Advanced Integrated Visibility-projekt efter 90 dagar.
• Skyddad spårningsinformation som mottagaradress och mottagarens signatur kommer inte att vara tillgänglig via Advanced Integrated Visibility Tracking Number Subscription.