Interfața API Advanced Integrated Visibility Înregistrare număr de urmărire le permite abonaților Advanced Integrated Visibility să asocieze numere de urmărire cu un proiect bazat pe webhook, utilizând punctele finale ale interfeței API. Funcționalitatea de asociere a numerelor de urmărire acceptă două metode de procesare:

• Asocierea numerelor de urmărire – Sincron returnează rezultatele procesării în cadrul aceluiași răspuns HTTP. Această opțiune este cea mai potrivită pentru aplicațiile care necesită confirmare imediată la asocierea unui număr mai mic de numere de urmărire. 
• Asocierea numerelor de urmărire – Asincron trimite solicitarea pentru procesare în fundal și returnează un ID de activitate care poate fi utilizat ulterior pentru a prelua starea procesării și rezultatele. Această opțiune este cea mai potrivită pentru procesarea unor loturi mai mari de numere de urmărire. 

Alegeți metoda de procesare care corespunde cel mai bine cerințelor de performanță și de volum de lucru ale aplicației dvs.

Notă:

• Trebuie să aveți acces de administrator sau contribuitor pentru proiectul dvs. Advanced Integrated Visibility
• Pentru mai multe informații despre Advanced Integrated Visibility și caracteristicile acesteia, accesați pagina Documentație Advanced Integrated Visibility.

Interfață API Advanced Integrated Visibility Înregistrare număr de urmărire oferă următoarele avantaje:

• Puteți asocia, actualiza și gestiona cu ușurință numerele de urmărire pentru proiectul dvs. bazat pe webhookul Advanced Integrated Visibility, utilizând punctele finale ale interfeței API.
• Asociați mai multe numere de urmărire într-o singură solicitare pentru interfața API, în loc să procesați fiecare număr de urmărire individual.
• Alegeți între procesarea sincronă, pentru rezultate imediate, și procesarea asincronă, pentru operațiuni cu loturi mai mari.

Utilizați punctele finale următoare jos pentru a vă gestiona proiectul Advanced Integrated Visibility:

• Asocierea numerelor de urmărire – Sincron: vă permite să asociați numere de urmărire cu un webhook și să primiți starea finală a procesării în cadrul aceluiași răspuns HTTP.
• Asocierea numerelor de urmărire – Asincron: vă permite să asociați numere de urmărire cu un webhook și să utilizați ulterior jobId returnat pentru a verifica starea activității asincrone sau pentru a descărca detalii utilizând punctele finale aferente:    
  • Stare activitate număr de monitorizare
  • Detalii activitate număr de monitorizare

Aceste interfețe API sunt disponibile din prezentarea generală a proiectului dvs. Advanced Integrated Visibility.

Aceste interfețe API pot fi accesate numai prin prezentarea generală a proiectului, așa cum se arată în captura de ecran de mai sus.

Următorul tabel rezumă deosebirile dintre punctele finale de asociere a numărului de urmărire sincrone și asincrone.
 

Utilizați punctul final sincron atunci când aveți nevoie de confirmare imediată pentru loturi mai mici de numere de urmărire. Utilizați punctul final asincron atunci când procesați loturi mai mari care nu necesită un răspuns imediat.

Utilizați acest punct final pentru a asocia unul sau mai multe numere de urmărire cu un proiect bazat pe webhookul Advanced Integrated Visibility și pentru a primi rezultatele procesării în cadrul aceluiași răspuns HTTP.

Acest punct final este destinat aplicațiilor care necesită confirmare imediată și acceptă solicitări care conțin până la 150 de numere de urmărire.

Date de intrare necesare: 

• subscriptionID
• trackingNumber

Avantaje

Punctul final sincron oferă următoarele avantaje:

• Rezultate imediate ale procesării
• Informații detaliate despre succes și eșec într-un singur răspuns
• Suport pentru până la 150 de numere de urmărire per solicitare
• Validarea solicitării și aplicarea regulilor de business înainte de procesare
• Coduri de eroare care pot fi citite automat și mesaje de eroare descriptive
• ID-uri de tranzacție pentru urmărirea solicitărilor și depanare

Punctul final Asocierea numerelor de urmărire – Sincron aplică mai multe reguli de validare, printre care:

• Necesitatea unui subscriptionId valid și activ
• Permiterea unui singur subscriptionId per solicitare
• Necesitatea unui trackingNumber
• Asigurarea faptului că numerele de urmărire respectă cerințele de formatare FedEx, inclusiv limita de 6 până la 22 de cifre pentru numărul de urmărire

Răspunsurile de eroare respectă o structură consecventă, în care errors[] conține code și message, pentru a facilita procesarea automată.

"errors": [

{

"code": "ERROR.CODE",

"message": "Mesaj de eroare descriptiv"

}

Punctul final Asocierea numerelor de urmărire – Sincron permite succese parțiale. Atunci când unele numere de urmărire eșuează, interfața API sincronă returnează totuși 200 OK și afișează următoarele:

• failedTrackingNumbers
• Un mesaj descriptiv

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Numerele de urmărire de mai jos nu au putut fi încărcate din cauza erorilor de validare sau de sistem"

      }

    }

Consultați secțiunile privind regulile de business pentru detalii și reguli suplimentare.

Utilizați acest punct final pentru a trimite unul sau mai multe numere de urmărire înregistrate pentru procesare în fundal.

Solicitarea returnează un ID de job pe care îl puteți utiliza cu punctul final Stare activitate număr de urmărire pentru a monitoriza procesarea și cu punctul final Detalii activitate număr de urmărire pentru a descărca rezultatele procesării după finalizarea jobului.

Date de intrare necesare:

• Acțiune
• Detalii număr de urmărire

Puteți asocia până la 1.000 de numere de urmărire într-o singură solicitare.

Avantaje

Punctul final asincron oferă următoarele avantaje:

• Acceptă trimiteri de loturi mari, de până la 1.000 de numere de urmărire
• Permite procesarea în fundal a solicitărilor de lungă durată
• Permite monitorizarea stării activității și descărcarea rapoartelor de procesare
• Elimină problemele legate de timpul de expirare a solicitărilor pentru volume mari de date

Utilizați acest punct final pentru a obține starea unei activități asincrone (una sau mai multe solicitări consecutive plasate în coadă) sau starea tuturor activităților trimise.

Informațiile de intrare necesare pentru această solicitare sunt:

• jobID – Specificați ID-ul activității pentru care intenționați să preluați starea.

Note: ID-ul activității este o intrare opțională pentru acest punct final. Dacă nu specificați ID-ul activității, atunci veți obține starea tuturor activităților trimise.

Răspunsul cu succes la această solicitare va returna ID-ul activității, starea curentă a activității și datele de creare și de finalizare a activității. Răspunsul va arăta starea curentă a activităților. În plus, răspunsul va conține, de asemenea, mesaje de succes, erori sau avertizări pentru ca utilizatorii să le poată vizualiza și depana, după caz.

• Dacă starea activității este afișată ca fiind FINALIZATĂ, înseamnă că toate numerele de monitorizare au fost validate și procesate cu succes.
  • Starea FINALIZATĂ presupune că numerele de monitorizare sunt validate și procesate cu succes. Aceasta nu înseamnă că toate numerele de monitorizare au fost adăugate cu succes la proiectul Advanced Integrated Visibility. 
  • Pentru activitățile cu mai multe numere de urmărire starea poate fi considerată COMPLETED chiar dacă unele numere nu reușesc să se asocieze cu proiectul, iar altele reușesc. Pentru a confirma starea fiecărui număr de urmărire din solicitarea de asociere inițială, descărcați raportul lotului.

Notă: Dacă starea activității este afișată ca fiind EȘUATĂ, acest lucru înseamnă că, din diverse motive/defecțiuni hardware, solicitarea nu a putut fi procesată, iar utilizatorul trebuie să o încerce din nou.

Tabelul următor prezintă stările activităților și descrierile aferente:

Utilizați acest punct final pentru a descărca raportul JSON pentru o activitate asincronă care se află în starea FINALIZATĂ.

Informațiile de intrare necesare asociate cu această solicitare sunt:

• jobID – Specificați ID-ul activității pentru care intenționați să preluați starea. Un ID de activitate este obligatoriu pentru acest punct final.

Notă:

• Puteți descărca un singur raport de activitate asincron la un moment dat.
• Dacă activitatea nu este FINALIZATĂ și încercați să descărcați raportul, se afișează un mesaj de eroare.

Răspunsul de succes pentru această solicitare vă furnizează raportul activității în format JSON.

Reguli de business comune

• Nu există o limită pentru numărul total de numere de urmărire care pot fi asociate cu un proiect Advanced Integrated Visibility.
• Numerele de urmărire asociate cu un proiect Advanced Integrated Visibility sunt disociate la 40 de zile după ce au fost asociate cu succes cu webhookul.
• Informațiile securizate de urmărire, precum adresa destinatarului, semnătura destinatarului și alte informații sensibile despre livrare, nu sunt disponibile prin intermediul interfeței API Înregistrare număr de urmărire.

Reguli de business pentru punctul final sincron

• Maximum 150 de numere de urmărire per solicitare.
• Toate numerele de urmărire trebuie să utilizeze același subscriptionId.
• Înregistrarea la webhookul Advanced Integrated Visibility specificată trebuie să fie validă și activă.
• Solicitările au un timp de expirare de 30 de secunde.

Reguli de business pentru punctul final asincron

• Maximum 150 de numere de urmărire per solicitare.
• Starea activității și detaliile activității pentru o solicitare asincronă sunt păstrate timp de 90 de zile după ce numerele de urmărire au fost asociate cu succes cu webhookul Advanced Integrated Visibility.