Så här fungerar Advanced Integrated Visibility
Advanced Integrated Visibility-webhooken gör att FedEx kan skicka säkra spårningsuppdateringar till en specifik URL, praktiskt taget i realtid. De här uppdateringarna är till för försändelser som är länkade till ett eller flera FedEx-kontonummer. Du måste skapa ett Advanced Integrated Visibility-webhookprojekt för att kunna använda den här funktionen.
Så här kommer du åt Advanced Integrated Visibility-sidan
Du kan komma åt Advanced Integrated Visibility-konfigurationen på två sätt:
Alternativ 1: via Mina projekt
1. Gå till Mina projekt i den vänstra navigeringspanelen.
2. Klicka på fliken Webhookar.
3. Välj +SKAPA ETT WEBHOOKPROJEKT.
Alternativ 2: via API-katalogen
1. Öppna API-katalogen i den vänstra navigeringspanelen.
2. Sök efter Advanced Integrated Visibility.
3. Använd filtret WEBHOOK för att hitta rätt kort.
4. På kortet:
- Klicka på Översikt, följt av knappen Dokumentation och välj sedan +SKAPA ETT WEBHOOKPROJEKT.
- Alternativt kan du gå till DOKUMENTATION och klicka på +SKAPA ETT WEBHOOKPROJEKT.
Steg 1: Välj företagstyp
Klicka på +SKAPA ETT PROJEKT och välj företagstyp i rullgardinsmenyn:
1. Skickar med FedEx och behöver integrera FedEx-webhookar i sitt system.
2. Säljer eller tillhandahåller en programvarulösning som använder FedEx-data och är inte en certifierad FedEx Compatible Provider.
3. Är en certifierad FedEx Compatible Provider.
Välj därefter Spårningsnummerbaserad Advanced Integrated Visibility-prenumeration som prenumerationstyp.
Skapa en spårningsnummerbaserad Advanced Integrated Visibility-prenumeration
Du kan skapa en spårningsnummerbaserad Advanced Integrated Visibility-prenumeration för att ta emot säkra spårningsuppdateringar för ett eller flera FedEx-spårningsnummer, praktiskt taget i realtid. Uppdateringarna skickas till en destinations-URL som du anger.
Så här skapar du prenumerationen
Processen består av fyra steg:
1. Konfigurera projektet
2. Ange projektuppgifter
3. Bekräfta uppgifterna och godkänn villkoren
4. Lägg till spårningsnummer
Steg-för-steg-instruktioner
1. På sidan Konfigurera webhook:
Kontrollera faktureringskontonumret
Organisationens standardkontonummer för fakturering kommer att visas.
Så här ändrar du det:
- Klicka på LÄGG TILL FAKTURERINGSKONTO FÖR ORGANISATIONEN (om du endast har ett konto), eller
- Klicka på VÄLJ ETT ANNAT FAKTURERINGSKONTO (om du har flera konton).
Obs! Prisuppgifter finns på sidan Översikt över Advanced Integrated Visibility.
2. Välj funktioner
- Välj de funktioner som du behöver.
- Klicka på Nästa för att fortsätta.
Tips: Om du vill veta mer om en funktion kan du klicka på hjälpikonen (?) bredvid funktionen.
Funktionsbeskrivningar
| Fältnamn | Beskrivning |
|---|---|
| Leveranskvitto | Bekräftar att en försändelse har levererats. Detta inkluderar följande:
|
| 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:
|
Ange följande information på sidan Ange 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). |
3. På sidan Bekräfta uppgifter:
- Granska uppgifterna för webhookprojektet.
- Läs och godkänn villkoren.
- Klicka på Skapa för att slutföra konfigurationen av webhookprojektet.
4. När begäran har skickats:
- FedEx kommer att skapa ett nytt webhookprojekt.
- Du kommer att få produktionsnycklar för Advanced Integrated Visibility Tracking Number Subscription API.
- Du kan använda det här API:et för att koppla spårningsnummer till projektet.
Mer information finns på sidan Dokumentation för Advanced Integrated Visibility Tracking Number Subscription API.
Så här lägger du till ett spårningsnummer för en webhook
Följ de här stegen för att lägga till ett spårningsnummer för webhookprenumerationen med hjälp av Advanced Integrated Visibility Tracking Number Subscription API:
Steg-för-steg-instruktioner
1. 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.
2. 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.
3. Ö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