Fedex Logo

CREAȚI UN
WEBHOOK GESTIONARE WEBHOOKURI

Cum funcționează Advanced Integrated Visibility

Webhookul Advanced Integrated Visibility permite FedEx să trimită actualizări de urmărire securizate, aproape în timp real, către un anumit URL. Aceste actualizări sunt pentru expedierile legate de unul sau mai multe numere de cont FedEx. Pentru a utiliza această funcție, trebuie să creați un proiect webhook Advanced Integrated Visibility.

Cum se accesează pagina Advanced Integrated Visibility

Puteți ajunge la configurarea Advanced Integrated Visibility în două moduri:

Opțiunea 1: Prin Proiectele mele

    1. Accesați Proiectele mele în panoul de navigare din stânga.

    2. Faceți clic pe fila Webhookuri.

    3. Selectați +CREAȚI UN PROIECT WEBHOOK.

Opțiunea 2: Prin intermediul Catalogului de interfețe API

    1. Deschideți Catalogul de interfețe API din panoul de navigare din stânga.

    2. Căutați Advanced Integrated Visibility.

    3. Utilizați filtrul WEBHOOK pentru a găsi cardul corect.

    4. În card:

  •  Faceți clic pe Prezentare generală, apoi pe butonul Documentație și alegeți +CREAȚI UN PROIECT WEBHOOK.
  •  Sau accesați DOCUMENTE și faceți clic pe +CREAȚI UN PROIECT WEBHOOK.

 

Pasul 1: Selectați tipul de companie

Apăsați pe +CREAȚI UN PROIECT și alegeți tipul companiei dvs. din meniul derulant:

    1. Expediază cu FedEx și are nevoie să integreze webhookul FedEx în propriul sistem.

    2. Vinde sau furnizează o soluție software care utilizează date FedEx și nu este furnizor FedEx Compatible certificat.

    3. Este un furnizor FedEx Compatible certificat.

 

Apoi, selectați Înregistrare număr de cont Advanced Integrated Visibility ca tip de înregistrare.

Crearea unei înregistrări pe baza numărului de monitorizare Advanced Integrated Visibility

Puteți configura o înregistrare de număr de monitorizare Advanced Integrated Visibility pentru a primi actualizări securizate, aproape în timp real, pentru unul sau mai multe numere de monitorizare FedEx. Aceste actualizări sunt trimise la un URL de destinație pe care îl specificați.

 

Pași pentru crearea înregistrării

Procesul implică patru pași principali:

    1. Configurați proiectul

    2. Introduceți detaliile proiectului

    3. Confirmați detaliile și acceptați condițiile

    4. Adăugați numere de monitorizare

 

Instrucțiuni pas cu pas

    1. În pagina Configurare webhook:

         Verificați numărul contului de facturare

         Se va afișa numărul contului de facturare implicit al organizației dvs.

         Pentru a-l schimba:

  •  Faceți clic pe ADĂUGAȚI UN CONT DE FACTURARE LA ORGANIZAȚIA DVS, (dacă aveți un singur cont) sau
  •  Faceți clic pe SELECTAȚI UN ALT CONT DE FACTURARE (dacă aveți mai multe conturi).

 

Notă: pentru detalii legate de prețuri, acesați pagina Prezentare generală Advanced Integrated Visibility.

 

2. Selectați funcții

  •  Alegeți funcțiile de care aveți nevoie.
  •  Faceți clic pe Înainte pentru a continua.

Sfat: pentru a afla mai multe despre fiecare funcție, faceți clic pe pictograma de ajutor icon (?) din dreptul funcției.

Descrieri ale funcțiilor

Numele câmpului Descriere
Confirmare de primire Confirmă că o expediere a fost livrată cu succes. Include:
  • Imaginea confirmării de primire (PPODA): furnizează o fotografie care arată locația exactă a livrării.
  • Semnătură de confirmare de primire (SPOD): furnizează o imagine a semnăturii destinatarului, numele, data, ora și locul livrării.
Livrare estimată Ajută destinatarii să planifice furnizând:
  • Dată de livrare estimată (EDD)
  • Intervalul de timp pentru livrare estimat (EDTW)
Evenimente de monitorizare Permite selectarea uneia sau mai multor categorii de evenimente pentru a primi notificări:
  • Expediere
  • În tranzit
  • Livrare
  • Excepții

 

În pagina Introducere detalii, furnizați 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:
  • Trebuie să fie valid și funcțional
  • Trebuie să respecte sintaxa standardizată
  • Nu trebuie să includă fedex.com sau subdomeniile sale
  • Poate fi reutilizat pentru mai multe webhookuri
Consultați secțiunea Reguli și bune practici de afaceri pentru mai multe detalii.
Token de securitate Un secret partajat folosit pentru a autentifica și valida răspunsurile webhookului prin HMAC.
Cerințe:
  • 26–100 de caractere
  • Trebuie să includă cel puțin 1 literă mare, 1 literă mică și 1 cifră
  • Poate fi reutilizat pentru mai multe webhookuri
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:
  • Monitorizare detaliată – istoricul complet al evenimentelor
  • Urmărire specifică evenimentului – Doar cel mai recent eveniment
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).

3. În pagina Confirmare detalii:

  •  Examinați detaliile proiectului dvs. webhook.
  •  Verificați și acceptați termenele și condițiile.
  •  Faceți clic pe Creare pentru a finaliza configurarea proiectului webhook.

4. Odată ce solicitarea dvs. a fost depusă cu succes:

  •  FedEx va crea un nou proiect webhook.
  •  Veți primi cheile de producție pentru Advanced Integrated Visibility Tracking Number Subscription API.
  •  Puteți folosi această interfață API pentru a asocia numere de monitorizare cu proiectele dvs.

Pentru a afla mai multe, consultați pagina cu documentația pentru Advanced Integrated Visibility Tracking Number Subscription API.

Cum se adaugă un număr de monitorizare la un webhook

Pentru a adăuga un număr de monitorizare la înregistrarea dvs. webhook utilizând Advanced Integrated Visibility Tracking Number Subscription API, urmați acești pași:

 

Proces pas cu pas

1. Creați un proiect de înregistrare

· Urmați pașii din secțiunea anterioară sau consultați Ghidul introductiv.

2. 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.

3. 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, derulează pentru a găsi documentația Advanced Integrated Visibility Tracking Number Subscription API.

Prezentare generală a punctelor finale API

Punct final Scop
Asociere număr 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ă.
CLOSE

Response

Copy