Cum funcționează Advanced Integrated Visibility
Prezentare generală a webhookului Advanced Integrated Visibility
Webhookul Advanced Integrated Visibility permite FedEx să transmită în siguranță, aproape în timp real, date privind evenimentele de monitorizare către un URL de destinație specificat pentru expedieri asociate cu numărul (numerele) de cont FedEx desemnat(e).
Pentru a utiliza această funcționalitate, un administrator FedEx sau administrator DI trebuie să creeze un proiect webhook Advanced Integrated Visibility.
Opțiuni de navigare
Puteți accesa pagina Webhookuri Advanced Integrated Visibility în două moduri:
Opțiunea 1: Prin Proiectele mele
- Navigați la Proiectele mele din panoul de navigare din stânga.
- Faceți clic pe fila Webhookuri.
Opțiunea 2: Prin intermediul Catalogului de interfețe API
- Accesați Catalogul de interfețe API din panoul de navigare din stânga.
- Utilizați bara de căutare pentru a găsi Advanced Integrated Visibility sau selectați din secțiunea FILTRE.
- În cardul Webhook, alegeți una dintre următoarele opțiuni:
- Faceți clic pe Documente → + Gestionare webhookuri
Vizualizarea unui proiect de înregistrare pe baza numărului de monitorizare Advanced Integrated Visibility
1. Accesați și configurați contul personal FedEx
- Un administrator FedEx sau un reprezentant FedEx va iniția procesul de configurare.
- Profilul organizației este creat de un administrator desemnat în numele clienților CSP.
- Un număr eligibil de cont de facturare din SUA este adăugat la nivel de organizație de către administrator în numele clientului.
- Administratorul care efectuează această configurare trebuie să aibă permisiunile corespunzătoare pentru a gestiona configurații la nivel de organizație.
2. Vizualizați fluxul de lucru pentru înregistrarea pe baza numărului de monitorizare
2.1 Vizualizați înregistrarea
- Odată ce un administrator sau reprezentant FedEx creează un proiect, utilizatorii pot vizualiza proiectul Advanced Integrated Visibility – Înregistrare pe baza numărului de monitorizare as0ciat în tabloul de bord.
2. Vizualizați funcțiile
- Utilizatorii pot explora funcțiile disponibile asociate proiectului de înregistrare pentru o mai bună înțelegere și utilizare.
Descrieri ale funcțiilor
| Numele câmpului | Descriere |
|---|---|
| Confirmare de primire | Confirmă că o expediere a fost livrată cu succes. Include:
|
| Livrare estimată | Ajută destinatarii să planifice furnizând:
|
| Evenimente de monitorizare | Permite selectarea uneia sau mai multor categorii de evenimente pentru a primi notificări:
|
În pagina Detalii vor fi afișate următoarele informații:
| Numele câmpului | Descriere |
|---|---|
| Numele proiectului Webhook | Un nume unic, care nu este gol, pentru proiectul dvs. webhook. Este completat automat un nume sugerat, dar acesta poate fi modificat. Acest nume nu trebuie repetat în niciun alt webhook. |
| URL destinație | Punctul final HTTPS securizat unde FedEx va trimite datele evenimentelor de monitorizare. Cerințe:
|
| Token de securitate | Un secret partajat folosit pentru a autentifica și valida răspunsurile webhookului prin HMAC. Cerințe:
|
| Limba datelor transmise (Țară) | Selectați din lista derulantă limba preferată pentru traducerea datelor de monitorizare. |
| Tip urmărire | Alegeți modul în care trebuie livrate datele de monitorizare:
|
| Adresă de e-mail | Furnizați o adresă de e-mail validă pentru a primi notificări. |
| Limba (țara) pentru e-mailuri | Selectați limba preferată pentru notificările prin e-mail. Notă: sunt acceptate doar setările regionale din SUA (de exemplu, en-US, es-US). |
Proces pas cu pas
4. Creați un proiect de înregistrare
- Urmați pașii din secțiunea anterioară sau consultați Ghidul introductiv.
5. Generați un token OAuth
- Aveți nevoie de un token OAuth pentru a efectua apeluri API.
- Utilizați Authorization API pentru a genera tokenul.
- Consultați documentația pentru Authorization API din Catalogul de interfețe API pentru pași detaliați.
6. Accesați-documentația pentru Access API
- În meniul de navigare din stânga, faceți clic pe Detalii proiect.
- În fila Chei de producție, derulați pentru a găsi documentația pentru Advanced Integrated Visibility Tracking Number Subscription API.
Prezentare generală a punctelor finale API
| Punct final | Scop |
|---|---|
| Asocierea numărului de monitorizare | Adăugați sau eliminați numere de monitorizare dintr-o înregistrare webhook. Aceasta este o sarcină asincronă. Un ID de sarcină este returnat în răspuns. |
| Detalii sarcină număr de monitorizare | Furnizează detalii pentru un anumit ID de sarcină, cum ar fi câte numere de monitorizare au fost adăugate cu succes sau sunt încă în procesare. |
| Stare sarcină număr de monitorizare | Returnează un rezumat al tuturor sarcinilor care sunt procesate curent. |
Utilizați tokenul OAuth de la Pasul 2 cu punctul final Asociere număr de monitorizare pentru a adăuga numere de monitorizare la webhookul dvs.
Reguli de validare
- Numele webhookului trebuie să fie unic.
- URL-ul de destinație trebuie să respecte formatul sintactic standard.
- Toate câmpurile obligatorii trebuie să fie completate.
- Trebuie asociat cel puțin un număr cont de expediere FedEx valid.
Rezultatele validării
| Status | Detalii |
|---|---|
| Succes | Este afișat un mesaj de confirmare: „<> a fost creat cu succes. Aplicarea modificărilor poate dura până la 10 minute.” |
| Eșec | Dacă FedEx primește un alt răspuns decât 200 (OK) sau 202 (Acceptat), validarea URL-ului de destinație webhook este considerată eșuată. |
