Så här fungerar Advanced Integrated Visibility
Översikt över Advanced Integrated Visibility-webhooken
Advanced Integrated Visibility-webhooken gör det möjligt för FedEx att skicka säkra spårningsdata praktiskt taget i realtid till en angiven destinations-URL för försändelser som är kopplade till ett eller flera FedEx-kontonummer.
Om du vill använda den här funktionen måste en FedEx-administratör eller DI-administratör skapa ett Advanced Integrated Visibility-webhookprojekt.
Navigeringsalternativ
Du kan komma åt sidan Advanced Integrated Visibility-webhookar på två sätt:
Alternativ 1: via Mina projekt
- Gå till Mina projekt i den vänstra navigeringspanelen.
- Klicka på fliken Webhookar.
Alternativ 2: via API-katalogen
- Gå till API-katalogen i den vänstra navigeringspanelen.
- Använd sökfältet för att hitta Advanced Integrated Visibility eller välj den i avsnittet FILTER.
- Välj något av följande på webhookkortet:
- Klicka på Dokumentation och klicka sedan på + Hantera webhookar.
Visa ett projekt för spårningsnummerbaserad Advanced Integrated Visibility-prenumeration
1. Personlig åtkomst och FedEx-konfiguration
- En FedEx-administratör eller FedEx-representant kommer att inleda konfigurationsprocessen.
- Organisationsprofilen skapas av en utsedd administratör på uppdrag av CSP-kunder.
- Ett kontonummer för ett berättigat USA-baserat faktureringskonto läggs till på organisationsnivå av administratören för kundens räkning.
- Administratören som utför konfigurationen måste ha rätt behörigheter för att hantera konfigurationer på organisationsnivå.
2. Visa arbetsflöde för spårningsnummerbaserad prenumeration
2.1 Visa prenumerationen
- När en FedEx-administratör eller -representant skapar ett projekt kan användarna visa det kopplade projektet för spårningsnummerbaserad Advanced Integrated Visibility-prenumeration i sin översikt.
2. Visa funktioner
- Användare kan utforska de tillgängliga funktionerna som är kopplade till prenumerationsprojektet för att få en bättre förståelse och förbättra användningen.
Funktionsbeskrivningar
| Fältnamn | Beskrivning |
|---|---|
| Leveranskvitto | Bekräftar att en försändelse har levererats. Följande ingår:
|
| Beräknad leverans | Hjälper mottagare att planera genom att tillhandahålla följande:
|
| Spårningshändelser | Gör det möjligt att välja en eller flera händelsekategorier för att ta emot aviseringar:
|
Följande information kommer att visas på sidan Uppgifter:
| Fältnamn | Beskrivning |
|---|---|
| Webhookprojektets namn | Ett unikt namn för webhook-projektet. Ett namnförslag fylls i automatiskt med kan redigeras. Namnet ska inte repeteras i andra webhook-projekt. |
| Destinations-URL | Den säkra HTTPS-slutpunkten dit FedEx kommer att skicka spårningshändelsedata. Krav:
|
| Säkerhetstoken | En delad hemlighet som används för att autentisera och validera webhooksvar via HMAC. Krav:
|
| Språk för data (land) | Välj önskat språk för översättning av spårningsdata i rullgardinsmenyn. |
| Spårningstyp | Välj hur spårningsdata ska levereras:
|
| E-postadress | Ange en giltig e-postadress för att få aviseringar. |
| Språk för e-post (land) | Välj vilket språk du vill få e-postaviseringar på. Obs! Endast språkvarianter för USA stöds (t.ex. en-US, es-US). |
Steg-för-steg-instruktioner
4. Skapa ett prenumerationsprojekt
- Följ stegen i det föregående avsnittet eller läs mer i guiden för att komma i gång.
5. Generera en OAuth-token
- Du behöver en OAuth-token för att kunna göra API-anrop.
- Använd Authorization API för att generera token.
- Detaljerade instruktioner finns i Dokumentation för Authorization API i API-katalogen.
6. Öppna API-dokumentationen
- Klicka på Projektuppgifter i den vänstra navigeringsmenyn.
- Under fliken Produktionsnycklar bläddrar du för att hitta Dokumentation för Advanced Integrated Visibility Tracking Number Subscription API.
Översikt över API-slutpunkter
| Slutpunkt | Syfte |
|---|---|
| Koppling av spårningsnummer | Lägg till eller ta bort spårningsnummer från en webhookprenumeration. Det här är ett asynkront jobb. Ett jobb-ID returneras i svaret. |
| Uppgifter för spårningsnummerjobb | Tillhandahåller uppgifter om ett specifikt jobb-ID, som hur många spårningsnummer som har lagts till eller som fortfarande bearbetas. |
| Status för spårningsnummerjobb | Returnerar en sammanfattning över alla jobb som för närvarande bearbetas. |
Använd OAuth-token från steg 2 tillsammans med slutpunkten Koppling av spårningsnummer för att lägga till spårningsnummer för webhooken.
Valideringsregler
- Webhookens namn måste vara unikt.
- Destinations-URL:en måste följa ett standardiserat syntaktiskt format.
- Alla obligatoriska fält måste fyllas i.
- Minst ett giltigt FedEx-försändelsekontonummer måste vara kopplat.
Valideringsresultat
| Status | Information |
|---|---|
| Lyckad | Ett bekräftelsemeddelande visas: ”<> har skapats. Det kan ta upp till tio minuter innan ändringarna tillämpas.” |
| Misslyckad | Om FedEx tar emot något annat svar än 200 (OK) eller 202 (Accepterad) betraktas valideringen av webhookens destinations-URL som misslyckad. |
Response