API-projekt létrehozása

Látogasson el a Saját projektek oldalra, és nyissa meg az API-k lapot. Kattintson az API-projekt létrehozása gombra.

1. lépés: Válassza ki a projektjébe beépíteni kívánt API-(ka)t

Tekintse át az API-kvóták, az árazási korlátok és az API-hitelesítés részleteit.

2. lépés: Konfigurálja a projekt részleteit

• Adjon szervezetén belül egyedi, beszédes nevet projektjének.
• Válassza ki azokat az országokat, ahová szállítani kíván, hogy hozzárendelhessünk Önhöz egy próbaszállítási ügyélszámot. Ha az európai országokon belüli belföldi csomagszállítást szeretné tesztelni, akkor minden országhoz külön tesztelési ügyfélszámra lesz szüksége. Később is bármikor hozzáadhat vagy eltávolíthat országokat.
• Ha értesítést szeretne kapni a legújabb API-frissítésekről és az üzemzavarral kapcsolatos információkról, megadhatja az értesítési beállításokat.

3. lépés: Olvassa el és fogadja el a feltételeket, beleértve a FedEx Developer Portal licencszerződését is

Miután elfogadta a feltételeket, és a Létrehozás gombra kattintott, egy megerősítő képernyő jelenik meg. Ezután megtekintheti a tesztelési hitelesítő adatait az új projektben.

Webhookprojekt létrehozása

Hozzon létre érvényes (visszahívási) URL-t a célalkalmazásában vagy célplatformján

Az Ön cél-URL-címe a FedExtől érkező hitelesítési kódok és üzenetek, valamint a webhook-adattartalommal kapcsolatos értesítések fogadására szolgál. Az URL-nek HTTPS-t kell használnia a biztonság érdekében. Az URL-címe le lesz tiltva, ha a következőket tartalmazza:

• RFC1918 IP-tartomány
• fedex.com vagy bármelyik aldomainje
• Az URL-ben lévő IP-címek (beleértve a következőket: localhost, 127.0.0.1)

Biztonsági token létrehozása

Ez a biztonsági token titkos kulcsként használható az Ön szervezete és a FedEx között továbbított információk hitelesítésére és érvényesítésére. A biztonsági jelszónak a következőket kell tartalmaznia:

• Legalább 26 karakter és legfeljebb 100 karakter hosszú
• 1 nagybetű
• 1 kisbetű
• 1 numerikus karakter

Példa: Y1F6OiVUQW2JPSElmRE9U0IY5

Miután meghatározta az URL-címet és a biztonsági tokent, készen áll a webhookprojekt létrehozására. Látogasson el a Saját projektek oldalra, és nyissa meg a Webhookok lapot. Kattintson a Webhookprojekt létrehozása gombra.

Előfizetés típusának kiválasztása

A FedEx feladói eseményeiket regisztrálhatják ügyfélszámokhoz vagy fuvarlevélszámokhoz.

1. lépés: Erősítse meg számlázási ügyfélfiókját és válassza ki a funkciókat

• Ellenőrizze a megadott alapértelmezett számlázási ügyfélfiókot, hogy megerősítse, vagy válasszon egy másikat a szervezetéből.
• Konfigurálja projektjét olyan funkciók kiválasztásával, mint a kézbesítési igazolási lehetőségek, a kézbesítés becsült ideje, az események nyomon követése és az eseményalapú szűrés.

2. lépés: Adja meg a projekt részleteit

• Adjon szervezetén belül egyedi, beszédes nevet projektjének.
• Adja meg a cél-URL-címet és a biztonsági token adatait, amelyeket az előzetes beállítási hitelesítés során hozott létre (lásd a fenti lépéseket).
• Ha értesítést szeretne kapni a legújabb webhook-frissítésekről és a kieséssel kapcsolatos információkról, adja meg az e-mail-címét és a kívánt nyelvet.

3. lépés: Olvassa el és fogadja el a feltételeket

Miután elfogadta a feltételeket, beleértve a FedEx Developer Portal licencszerződést és a megrendelőlapot, és rákattintott a Létrehozás gombra, megjelenik egy megerősítő képernyő.

Az előfizetés típusának kiválasztása alapján további lépések is előfordulhatnak. Látogasson el a dokumentációhoz, ha többet szeretne megtudni.

Az API-projekt áttekintése lapon a Tesztkulcs lapon kérje le a tesztelési hitelesítő adatokat​​– az API-kulcsot, a titkos kulcsot és a fuvarozási fióko(ka)t. 

1. lépés: Igényeljen OAuth hozzáférési tokent

Az OAuth hozzáférési tokent minden egyes API-tranzakcióhoz használni kell. A token csak egy órán át érvényes, ezért alkalmazásába bele kell programoznia, hogy a munkamenet lejárta előtt frissítse a tokent. További részleteket az API-k hitelesítési dokumentációja tartalmaz.

2. lépés: Tekintse át az API-dokumentációt

Kattintson az egyes API-k dokumentációjára az üzleti kontextus elolvasásához és az API használatának megértéséhez. Jelentkezzen be a JSON API-gyűjtemény letöltéséhez a dokumentációs oldal tetején található gomb segítségével. Továbbá átnézheti a kívánt integrációnak megfelelő végponthoz tartozó kérési mintapéldákat.

3. lépés: Használja a tesztkörnyezetet a mintatranzakciók teszteléséhez

Kattintson a bal oldali navigációban a kívánt végpontra az adott tesztkörnyezetbe való átlépéshez. Határozza meg a felhasználási esetnek megfelelő mintakéréseket, majd a teszt hitelesítő adatok és a FedEx teszt-URL-címek segítségével valósítsa meg a végponthoz intézett hívásokat a példakérelmekben leírtak szerint. Ellenőrizze, hogy az API-hívásokra kapott válaszok megegyeznek-e a dokumentációban találhatóakkal. Tudjon meg többet a tesztelési tapasztalatainkról a Tesztelési környezet virtualizációs útmutatójában.

Tesztelés webhookokkal

A tesztelés segíthet jobb képet kapni arról, hogy az Ön által létrehozott URL érvényes-e. Ez lehetővé teszi a FedEx számára, hogy azonosítsa az Ön URL-címét, és kapcsolatot építsen ki az Ön URL-címével az adatok küldéséhez. A tesztelés olyan mintatesztadatokat is biztosíthat, amelyek segítségével ellenőrizheti és megerősítheti, hogy képes-e feldolgozni az alkalmazásban megadott nyomonkövetési adatokat. Azonban a tesztelés nem hitelesíti az URL-címét. Tekintse meg a Webhookdokumentáció oldalt, hogy megtudja, hogyan tesztelheti a webhook-URL-címét.

Látogasson el a Projektáttekintés oldalra, és nyissa meg az Élesítési kulcs lapot. Speciális integrált láthatósági ügyfélszám-előfizetési projekteket nem kell élesíteni.

1. lépés: Konfigurálja a projektet

• Nevezze át a kulcsot szükség szerint.
• Ellenőrizze a projekt létrehozási folyamatának 1. lépésében kiválasztott ügyfélszámot. Ez arra használatos, hogy a projektet éles környezetbe helyezze. Amint a projektje élesben üzemel, szükség szerint további fiókokat adhat hozzá.

2. lépés: Szerezze be a projektkulcsokat

Másolja az élesítési API-kulcsot és az élesítési titkos kulcsot egy biztonságos helyre. Hogy titokban maradhasson az éles környezet titkos kulcsa, csak egyszer jelenítjük meg. Ha elveszíti, létrehozhat egy újat.

Miután megkapta a projektkulcsokat, és a Tovább gombra kattintott, az Élesítési kulcs lapon láthatja a projekt adatait.

• Ha további fuvarozási ügyfélfiókokat szeretne hozzáadni a projektjéhez, kattintson a Szerkesztés gombra a fuvarozási ügyfélfiókok táblázata tetején.

Ahhoz, hogy az éles környezetünkben használhatóak legyenek, egyes API-k fuvarozásicímke-hitelesítést igényelnek. Ellenőrizze, hogy az API megköveteli-e a hitelesítést.

1. lépés: Fejlesszen, és tesztelje a FedEx API-kat webes alkalmazásával.

Miután befejezte webes alkalmazásának fejlesztését, ideje tesztelni a tesztelési hitelesítési adataival (a tesztelési szállítási ügyfélszámlával (ügyfélszámlákkal), a tesztelési API-kulccsal és a tesztelési titkos kulccsal). Tesztelési API-kulcsát és titkos kulcsát A projekt áttekintése oldalon találja, és bármikor megnézheti.

2. lépés Tegye át projektjét a termelési környezetbe.

Miután letesztelte a FedEx API-kat, el kell kezdenie a hitelesítési folyamatot azzal, hogy átteszi a projektjét a termelési környezetbe a FedEx Developer Portalon. Amikor ez sikeresen megtörtént, látni fogja termelési API-kulcsát és titkos kulcsát. A titkos kulcsa csak egyszer fog megjelenni, de később lehetősége lesz újra előállítani.

3. lépés: Töltse ki a Címke fedőlapját.

Hiánytalanul töltse ki a Címke kísérőlapját: írja be a megfelelő kapcsolattartási adatokat és azt, hogy milyen szolgáltatásokat szeretne implementálni. Írja be ügyfélszámát és termelési kulcsát is.

4. lépés: Állítson elő tesztcímkéket, és küldje be őket a vonalkódelemző csoportnak

Állítson elő tesztcímkéket az alkalmazáshoz rendelt FedEx tesztelési környezettel, majd küldje be őket a FedEx címkekiértékelő csapatához (csapataihoz) jóváhagyásra. A vonalkódelemző csoportnak a címkekiértékeléshez három munkanapra van szüksége.

Kövesse az alábbi legjobb gyakorlatokat a feldolgozási késedelmek elkerülése érdekében:

• A címkéket legalább 600 DPI-s felbontással kell kinyomtatni és beolvasni. NE KÜLDJÖN BE API-K ÁLTAL ELŐÁLLÍTOTT FÁJLOKAT!
• Hőnyomtatók esetén a nyomtató modelljének megfelelő címkeképtípust kell kérni. Példa: Zebra nyomtatók esetén ZPLII-t.
• Kiértékelésre szánt mintacímkék létrehozásakor használja a feladó/címzett címét. Csak azokhoz a konkrét szolgáltatásokhoz hozzon létre mintacímkét, amelyek számára a tanúsítást kéri.
• A FedEx® utánvétes (COD) címkének tartalmaznia kell a megfelelő utánvétes visszárucímkét is.
• A FedEx International Express® küldeményeknek tartalmazniuk kell a kiegészítő/másodlagos légi fuvarlevél (AWB) címkéjét is.
• A több darabból álló (MPS) küldeményeknek a küldemény minden egyes csomagjára vonatkozóan tartalmazniuk kell egy címkét.
• A PDF-fájlt és a Címke kísérőlapját küldje el e-mailben a következő e-mail-címre: label@fedex.com.
• A fizikai címkéket az alábbi címre küldheti:

       FedEx-szolgáltatások

       WTC-Business Solutions Testing

       10 FedEx Parkway

       2nd Floor Horizontal

       Collierville, TN 38017

Ha a beolvasott címkéken nincs látható hiba (például a vonalkódot keresztező vonal, tintafolt vagy fizikai sérülés), akkor valószínűleg átmennek az ellenőrzésen, és megkapják a jóváhagyást.


Fizikai címkék beküldése esetén figyeljen a nyomtatási minőségre és a címkék esetleges véletlen felnagyítására/lekicsinyítésére (azaz átméretezésére). Ez a két leggyakoribb oka annak, hogy a címkék elbuknak a kiértékelési folyamat során.

5. lépés: Tekintse át a címke értékelését

A vonalkódelemző csoport kiértékeli a beküldött tesztcímkéket, és jóváhagyja vagy elutasítja őket. A vonalkódelemző csoport tájékoztatni fogja Önt a beküldött címkék jóváhagyásáról vagy elutasításáról. Ha a címkék megkapták a jóváhagyást, akkor folytassa a következő lépéssel. Ha a címkéket visszautasították, akkor javítsa ki a címkéket az utasítások szerint, és küldje be őket újra jóváhagyásra.

6. lépés: Engedélyezze az alkalmazást

Miután a vonalkódelemző csoport jóváhagyta a tesztcímkéket az élesítési környezethez, engedélyezi az Ön élesítési hitelesítő adatait az azonosított fuvarozásicímke-tranzakció továbbítására, és e-mailben értesíti Önt a sikeres hitelesítésről. Egy-egy jóváhagyás csak az adott projektre vonatkozik.

7. lépés: Cserélje le az URL-t és a hitelesítési adatokat.

Cserélje le a tesztelési URL-t és a tesztelési hitelesítési adatokat a termelési URL-re, illetve a termelési hitelesítési adatokra. Mintaadatokat használva ismét tesztelje le a megvalósítást a termelési környezetben.