1. Creați un proiect pentru a obține credențiale
2. Integrați API-urile și testați implementarea
3. Transferați proiectul dumneavoastră în faza de producție
4. Finalizați procesul de certificare

Un administrator sau un colaborator al organizației dumneavoastră poate crea un proiect bazat pe API-uri dând clic pe butonul Creați un proiect bazat pe API-uri.

Înainte de a începe, va trebui să ne spuneți motivul pentru care este necesar să accesați API-urile FedEx. Va apărea o fereastră tip pop-up, care va prezenta opțiunile din meniul derulant. Trebuie să selectați opțiunea care reflectă cel mai fidel motivele pentru care afacerea dumneavoastră are nevoie de integrarea cu API-urile FedEx.

Dacă vă identificați ca expeditor, puteți începe să creați proiectul dumneavoastră. Procesul este compus din trei pași:

Selectați API-urile

Selectați API-urile pe care doriți să le includeți în proiect. În funcție de API-urile pe care le selectați, ar putea fi necesar să faceți câteva selecții suplimentare.

Dacă selectați API-ul de urmărire, va trebui să faceți și următorii pași:

• Selectați un număr de cont de client, pe care să îl asociați cu cheia dumneavoastră de producție.
• Verificați cotele și limitele numărului de tranzacții ale API-ului de urmărire și detaliile privind certificarea API-ului.
• Alegeți dacă doriți sau nu să primiți e-mailuri prin care vă veți afla dacă depășiți cota de tranzacții.

Configurare proiect

Introduceți câteva detalii legate de proiect, inclusiv numele și locul de livrare.

• Alocați proiectului un nume identificabil, care este unic în cadrul organizației dumneavoastră
• Selectați țările în care planificați expedieri, pentru a putea să vă alocăm un cont de expediere de test. Pentru a testa expedierea internă de colete pe teritoriul unei țări europene, trebuie să aveți câte un cont de test pentru fiecare țară. La nevoie, puteți să adăugați/să eliminați țări mai târziu.
• Puteți configura preferințe de notificare pentru a primi notificări despre cele mai recente actualizări ale API-urilor și despre întreruperi.

Confirmați detaliile

Verificați detaliile proiectului, apoi acceptați termenele și condițiile.

• Citiți și acceptați Acordul de licență pentru FedEx Developer Portal și confirmați faptul că nu intenționați să vindeți sau să distribuiți aplicația dumneavoastră.
• După ce ați făcut clic pe butonul „Creare”, va apărea un ecran de confirmare. Apoi veți putea vedea acreditările de test în noul proiect.

• Solicitați un token de acces OAuth, care trebuie utilizat la fiecare tranzacție API. Tokenul este valid doar pentru o oră, așadar, va trebui să vă codați programatic aplicația pentru a reîmprospăta tokenul înainte de a expira sesiunea. Pentru informații suplimentare, consultați documentele Autorizare API
• Dați clic pe orice document asociat API-urilor dumneavoastră pentru a citi contextul de afaceri al fiecărui API, astfel încât să puteți înțelege cel mai bine cum să-l folosiți. Puteți consulta exemplele de solicitări pentru destinația cererilor, care corespund integrării dorite.
• Implementați apelurile dvs. la aceste puncte finale conform descrierii din exemplele de solicitare, configurându-le să utilizeze acreditările dvs. de test.
• Asigurați-vă că răspunsurile la apelurile API, pe care le primiți, corespund cu cele afișate în documentație.
• Testați implementarea în cadrul mediului de test FedEx utilizând acreditările de test și adresele URL de test FedEx.

La pasul Configurați proiectul:

• Puteți redenumi cheia după cum doriți.
• Verificați numărul contului de client pe care l-ați selectat la pasul 1 al fluxului de creare a proiectului. Acesta este necesar pentru transferarea proiectului în faza de producție. După ce proiectul dumneavoastră este activ în faza de producție, puteți adăuga mai multe conturi de client, dacă va fi necesar.

La pasul Obțineți cheile de proiect:

• Se vor afișa cheia API de producție și cheia secretă de producție. Asigurați-vă că le copiați într-un loc sigur.
• Pentru a vă păstra în siguranță cheia secretă de producție, o afișăm doar o dată. Dacă o pierdeți, puteți să generați o cheie nouă.
• Faceți clic pe Înainte.

Veți reveni la pagina Prezentarea generală a proiectului. Aici puteți adăuga mai multe conturi de client, asociate proiectului.

Pe pagina Prezentarea generală a proiectului:

• Dați clic pe cele 3 puncte verticale (meniul kebab), pentru a adăuga mai multe conturi asociate proiectului dumneavoastră.
• Apoi dați clic pe Editați.

Veți fi direcționat către pagina Cheie API, unde puteți adăuga și alte conturi de client, pe care doriți să le asociați cu cheia de producție pentru acest proiect.

1. Unele API-uri necesită certificare privind eticheta de expediere pentru a fi utilizate în mediul nostru de producție. Finalizați procesul de certificare pentru orice API din cadrul proiectului dumneavoastră, care impun această cerință.

1. După ce toate API-urile au fost certificate și activate, actualizați-vă solicitările API înlocuind URI-urile, cheile și conturile de expediere de test cu URI-uri, chei și conturi de expediere de producție.

2. Retestați implementarea în mediul de producție utilizând mostre de date.

3. Bucurați-vă de avantajele noii dvs. integrări!

Cerințe preliminare pentru crearea unui proiect bazat pe webhook-uri

1. Creați o adresă URL validă în aplicația/platforma dumneavoastră de destinație
2. Generați tokenul de securitate
3. Testați adresa URL a webhook-ului
4. Validați adresa URL de destinație

Creați un proiect bazat pe webhook-uri

1. Creați un proiect bazat pe webhook-uri pentru a primi notificări configurate, referitoare la mesaj

Cerințe preliminare pentru crearea unui proiect bazat pe webhook-uri

Creați o adresă URL validă în aplicația/platforma dumneavoastră de destinație pentru a primi coduri/mesaje de autentificare și notificări privind webhook-urile de urmărire de la FedEx.

Cerințe privind adresa URL:

Acest token de securitate poate fi folosit drept cheie secretă pentru a autentifica și valida informațiile transmise între dumneavoastră (client) și FedEx.

Cerințe privind tokenul de securitate:

• o lungime minimă de 25 de caractere și o lungime maximă de 100 de caractere;
• 1 literă mare;
• 1 literă mică;
• 1 caracter numeric

Testarea adresei URL este un pas opțional, care s-ar putea să vă fie util.

Testarea vă poate ajuta să aflați dacă adresa URL creată la pasul 1 este validă. Astfel, FedEx va avea permisiunea de a vă identifica adresa URL și de a construi o conexiune cu adresa URL, cu scopul de a trimite date. De asemenea, testarea vă poate oferi exemple de date de test, care vă pot ajuta să verificați și să confirmați faptul că puteți procesa datele de monitorizare a expedierilor, furnizate în aplicația dumneavoastră. Totuși, testarea nu autentifică adresa dumneavoastră URL.

Consultați documentația noastră privind webhook-urile pentru a afla cum să testați URL-ul unui webhook.

Folosind metoda algoritmului de hashing HMAC SHA256, configurați un proces de autentificare pentru a valida informațiile transmise între adresa dumneavoastră URL de destinație și FedEx.

1. Când dați clic pe Creați, FedEx generează un șir aleatoriu de caractere, care este trimis către dumneavoastră în corpul cererii API. Dumneavoastră trebuie să returnați acest șir-provocare către FedEx, în corpul mesajului de răspuns.

1. Inițializați codul de autentificare a mesajelor (MAC) folosind algoritmul/procedura HMAC SHA256 pentru a codifica prin hash (sau combina) un șir de caractere și tokenul de securitate (sau cheia secretă), cu scopul de a forma o semnătură hash.

1. Trimiteți un răspuns către FedEx, care include parametrii challengeString și challengeStringResponse, împreună, în corpul răspunsului, și cu codul de stare HTTP 200 (OK) sau 202 (ACCEPTAT).

1. FedEx va valida șirul de caractere și răspunsul la acesta.

• După ce FedEx primește răspunsul, va valida parametrii challengeString și challengeStringResponse (sau semnătura hash, generată anterior), comparându-i cu challengeString și, respectiv, semnătura hash, generată de FedEx.

• Dacă semnăturile „challengeString” și HMAC corespund, înseamnă că validarea și fluxul de lucru au avut succes. În caz contrar, procesul de validare va eșua și se va afișa un mesaj de eroare corespunzător.

Creați un proiect bazat pe webhook-uri

Pe pagina Proiectele mele, accesați secțiunea Webhook-uri.

Un administrator sau un colaborator al organizației poate crea un proiect bazat pe webhook-uri dând clic pe butonul Creați un webhook.

Înainte de a începe, va trebui să ne spuneți motivul pentru care este necesar să accesați webhook-urile FedEx. Va apărea o fereastră tip pop-up, care va prezenta opțiunile din meniul derulant. Trebuie să selectați opțiunea care reflectă cel mai fidel motivele pentru care afacerea dumneavoastră are nevoie de integrarea cu webhook-urile FedEx.

Dacă vă identificați ca expeditor, puteți începe să creați proiectul parcurgând următorii pași:

1. Identificați necesitățile afacerii dumneavoastră

• Selectați opțiunea care reflectă cel mai fidel motivul pentru care doriți ca afacerea dumneavoastră să fie integrată cu webhook-urile FedEx.

1. Selectați nivelul și funcțiile aferente nivelului

• Selectați un nivel de webhook de bază sau avansat pentru proiectul dumneavoastră, în funcție de cerințele acestuia.
• Ulterior, puteți schimba oricând nivelul ales.
• Fiecare nivel are asociată o taxă lunară, de abonament.

• Selectați caracteristicile pe care doriți să le configurați pentru proiectul dumneavoastră.
• Puteți edita funcțiile mai târziu.

1. Configurați detaliile proiectului

• Acordați proiectului un nume care să-l facă ușor de identificat
• Indicați adresa URL de destinație și detaliile tokenului de securitate, generate în prealabil, care sunt create în timpul autentificării efectuate înainte de configurare.

Alegeți conturile

• Alegeți dintr-o listă de numere de cont de client eligibile (din SUA sau Canada), pe care doriți să le asociați cu proiectul dumneavoastră.

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

• Verificați detaliile proiectului configurat.
• Citiți și acceptați Acordul de licență pentru Developer Portal și confirmați faptul că nu intenționați să distribuiți aplicația.
• Citiți și acceptați Acordul privind tarifele.
• După ce dați clic pe butonul Creați un proiect:

1. Dacă solicitarea dumneavoastră de creare a fost validată și procesată cu succes, va apărea un ecran de confirmare.

• Dacă validarea nu reușește sau eșuează, va apărea un mesaj de eroare.

1. Apoi, proiectul dumneavoastră, bazat pe webhook-uri de urmărire, va avea un ID de webhook generat de sistem și va indica starea „Activ”.

1. FedEx creează organizația furnizorului Compatible.
2. Acceptați invitația.
3. Invitați utilizatori în organizația dvs.
4. Selectați API-urile de care aveți nevoie pentru soluția dvs.
5. FedEx creează proiecte.
6. Integrați API-urile în aplicația dvs. și certificați-o prin Compatible Program.
7. FedEx transferă proiectele în producție.
8. Generați cheia secretă de producție.

• FedEx va crea o organizație și apoi va invita un membru al echipei să se alăture organizației. Acest utilizator va fi desemnat ca administrator al organizației dumneavoastră.
• La finalizarea certificării și integrării, veți putea distribui soluția clienților dvs. cu ușurință.

• Pentru a obține accesul la artefactele și documentația API, acceptați invitația. Pentru a accepta invitația, va trebui fie să vă conectați cu ID-ul de utilizator și parola pentru FedEx, fie să vă creați un nou ID de utilizator, dacă nu aveți deja acreditări.

• Ca administrator, puteți să invitați toți membrii echipei care au nevoie de acces la proiect sau la organizație. Pentru detalii referitoare la diverse roluri, vizualizați Ghid de administrare a organizației.

• Dacă organizația dvs. a fost deja creată, solicitați-i administratorului organizației sau companiei FedEx să vă invite să vă alăturați. Veți avea la dispoziție 24 de ore pentru a accepta invitația, iar dacă nu vă încadrați în acest interval, îl puteți ruga să vă retrimită invitația.

• Accesați Catalogul API pentru a determina API-urile adecvate pentru soluția dumneavoastră. Specialistul FedEx Customer Technology, dedicat dumneavoastră, și managerul Compatible Channel vă pot ajuta să selectați API-urile adecvate pentru soluția dumneavoastră, în conformitate cu cerințele afacerii pe care o gestionați.

• Selectați un API pentru a-i descoperi prezentarea generală, jurnalele de modificări și caracteristicile cheie.

• Vizualizați documentele API-ului pentru a descoperi elementele de solicitare și de răspuns, exemplele din limbajul de programare ales, obiectele de eroare și multe altele.

• Reveniți la Forță de vânzare pentru a completa Fișa de lucru cu informații de producție (FLIP) în Product Information Worksheet (PIW) și enumerați API-urile pe care le doriți adăugate la soluția dvs.

După ce FLIP a fost aprobată, FedEx vă va crea proiectele. Fiecare versiune a fiecărei soluții va avea un proiect separat în cadrul FedEx Developer Portal. Dacă un utilizator nu este administratorul organizației, va trebui să fie invitat să vizualizeze fiecare proiect. 

Acest lucru este valabil și atunci când echipa FedEx Compatible alături de echipa CTC FedEx și echipa de certificare vor organiza o demonstrație tehnică pentru API-uri împreună cu echipa dvs. Echipa FedEx va discuta cu privire la noile caracteristici și funcționalități disponibile cu versiunea API-urilor pe care le adoptați. Echipa va putea să abordeze chestiunile tehnice privind API-urile, testarea API-urilor și toate procesele care trebuie finalizate pentru a începe procesul de „certificare*” pentru API-uri.

* Certificare – Procesul definit de FedEx Compatible Program pentru a satisface cerințele de conformitate pentru program. Certificarea Compatible Program este obligatorie pentru a se asigura că toți furnizorii Compatible implementează, comercializează și distribuie tehnologie FedEx către expeditori (clienți), în conformitate cu standardele tehnologiei și serviciilor FedEx.

1. Veți avea acum acces la cheia API de testare și la cheia secretă de testare pentru a începe executarea tranzacțiilor. Preluați-le din fila Cheie de testare din pagina Prezentare generală proiect.

1. Pentru a crea chei client, va trebui să utilizați API-ul de înregistrare a acreditărilor, care este un API privat găsit doar în secțiunea API din fiecare dintre proiectele dvs.
2. După ce ați creat câteva chei client, solicitați un token de acces OAuth care se va utiliza pentru fiecare tranzacție API. Sesiunea tokenului este validă doar pentru o oră, așadar, va trebui să vă codați programatic aplicația pentru a reîmprospăta tokenul înainte de a expira sesiunea. Consultați documentele Autorizare API pentru informații suplimentare. Când vizualizați codul eșantion, verificați dacă este selectat „Revânzător” din lista derulantă de eșantioane.

1. Selectați documentele pentru API-uri din pagina Chei de testare și citiți contextul de afaceri pentru a înțelege cel mai bine cum se utilizează API-ul selectat. Consultați exemplele de solicitare pentru punctul final care corespund integrării dorite.
2. Implementați apelurile dvs. la aceste puncte finale conform descrierii din exemplele de solicitare, configurându-le să utilizeze acreditările dvs. de testare.
3. Asigurați-vă că răspunsurile primite la apelurile API corespund celor afișate în documentație.
4. Testați complet implementarea în cadrul mediului de testare FedEx utilizând acreditările de testare și URI-urile de testare FedEx.
5. După ce v-ați testat complet soluțiile, certificați fiecare soluție în Forță de vânzare. FedEx va examina complet tot ce ați trimis și vă va anunța imediat ce v-a fost aprobată certificarea.

• FedEx vă va transfera apoi proiectele în producție.
• Veți putea apoi să vă vedeți cheia API de producție în fila Cheie producție din pagina Prezentare generală proiect.

• Cheia secretă de producție va trebui generată printr-un clic pe linkul Generați o cheie secretă, din coloana Cheie secretă.
• Acum puteți să vă retestați implementarea în mediul de producție prin utilizarea datelor eșantion.
• Bucurați-vă de avantajele noii dvs. integrări!