1. Hozzon létre egy projektet, hogy hitelesítő adatokat kapjon
2. API-k integrálása és a megvalósítás tesztelése
3. Tegye át projektjét az éles környezetbe
4. Fejezze be a tanúsítást

A szervezete valamely rendszergazdája vagy közreműködője létrehozhat API-projektet az API-projekt létrehozása gombra kattintva.

A kezdés előtt ossza meg velünk, miért kér hozzáférést a FedEx API-khoz. Megjelenik egy modális ablak, és legördülő listából választhat. Ki kell választania azt a lehetőséget, amelyik a legjobban meghatározza, hogy vállalkozása miért szeretné integrálni a FedEx-webhookokat.

Amennyiben Ön feladóként azonosítja magát, elkezdheti a projektje létrehozását. Ez egy három lépésből álló folyamat:

Válasszon ki API-kat!

Válassza ki azt az API-t/azokat az API-kat, amely(eke)t hozzá szeretne adni a projektjéhez. A kiválasztott API/API-k alapján lehetséges, hogy továbbiakat kell kijelölnie.

Amennyiben a Nyomonkövetési API-t választja ki, a továbbiakat is meg kell tennie:

• Válasszon ki egy ügyfélszámot, amelyet hozzá szeretne rendelni a éles környezet kulcshoz.
• Tekintse át az API-kvóták, az árfolyamkorlátok és az API-tanúsítás részleteit.
• Válassza ki, hogy szeretne-e olyan e-maileket kapni, amelyek értesítik Önt, ha túllépi a tranzakciós kvótáját.

Projekt konfigurálása

Adjon meg néhány projektjellemzőt, beleértve a nevet és a fuvarozási helyet.

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

Részletek megerősítése

Tekintse át a projektje részleteit, majd fogadja el a Fuvarozási Feltételeket.

• Olvassa el és fogadja el a FedEx Developer Portal licencszerződését, és nyilatkozzon arról, hogy nem áll szándékában terjeszteni az alkalmazását.
• Miután a „Létrehozás” gombra kattint, megerősítést kérő képernyő jelenik meg. Ezután megtekintheti a tesztelési hitelesítő adatait az új projektben.

• Kérjen egy OAuth hitelesítési tokent, amelyet minden API-tranzakciónál használnia kell majd. 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
• Kattintson az API-k dokumentumaira, és olvassa el az egyes API-k üzleti kontextusát, hogy a lehető legjobban megértse, hogyan kell használni őket. Továbbá átnézheti a kívánt integrációnak megfelelő végponthoz tartozó kérési mintapéldákat.
• A példakérésekben leírtak szerint hívja meg ezeket a végpontokat, és konfigurálja őket a tesztelési hitelesítő adatokkal.
• Ellenőrizze, hogy az API-hívásokra kapott válaszok megegyeznek-e a dokumentációban találhatóakkal.
• Tesztelje le implementációját a FedEx tesztelési környezetében, tesztelési hitelesítő adatait és a FedEx tesztelési URL-eket használva.

A Projekt konfigurálása lépésen belül:

• Szükség szerint átnevezheti a kulcsot.
• 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á.

A Projektkulcsok lekérése lépésen belül:

• Megjelenik az éles környezet API-kulcs és az éles környezet titkos kulcs. Feltétlenül írja le és biztonságos helyen őrizze meg őket.
• Azért, hogy titokban maradjon az éles környezet titkos kulcsa, csak egyszer jelenítjük meg. Ha elveszíti, létrehozhat egy újat.
• Kattintson a Következő gombra.

Ezután Ön visszakerül a Projekt áttekintése oldalra. Itt hozzáadhat további, a projektjéhez kapcsolódó ügyfélszámokat.

A Projekt áttekintése oldalon:

• Kattintson a 3 függőleges pontra (vagy a kebabmenüre) a projekthez kapcsolódó további ügyfélszámok hozzáadásához.
• Majd kattintson a Szerkesztés gombra.

Ezáltal az API-kulcs oldalra kerül, ahol hozzáadhat további olyan ügyfélszámokat, amelyeket a projekt éles környezet kulcsához szeretne társítani.

1. Ahhoz, hogy az éles környezetünkben használhatóak legyenek, egyes API-k fuvarozásicímke-tanúsítást igényelnek. Hajtsa végre a tanúsítási folyamatot projektjének minden tanúsítványt igénylő API-ja esetében.

1. Miután az összes API-t ellátta tanúsítvánnyal és engedélyezte, módosítsa az API-kéréseket úgy, hogy a tesztelési URI-kat, kulcsokat és fuvarozási ügyfélszámokat éles URI-kra, kulcsokra, illetve fuvarozási ügyfélszámokra cseréli le.

2. Mintaadatokat használva ismét tesztelje le a megvalósítást a termelési környezetben.

3. Élvezze az új integráció által kínált előnyöket!

Webhookprojekt létrehozásának előfeltételei

1. Hozzon létre érvényes URL-t a célalkalmazásában/célplatformján
2. Biztonsági token létrehozása
3. Teszt-webhook URL-címe
4. Cél-URL-cím hitelesítése

Webhookprojekt létrehozása

1. Hozzon létre webhookprojektet a konfigurált terhelési értesítések fogadásához

Webhookprojekt létrehozásának előfeltételei

Hozzon létre egy érvényes URL-címet a célalkalmazásban/-platformon a FedExtől érkező hitelesítési kódok/üzenetek és a nyomonkövetési webhook terhelésértesítéseinek fogadásához.

Az URL feltételei:

Ez a biztonsági token titkos kulcsként használható az Ön (az ügyfél) é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 token feltételei:

• legalább 25 karakter és legfeljebb 100 karakter hosszú
• 1 nagybetű;
• 1 kisbetű
• 1 numerikus karakter

Az URL-címe tesztelése egy nem kötelező lépés, ami azonban hasznos lehet.

A tesztelés segíthet jobb képet kapni arról, hogy az 1. lépésben létrehozott URL-cím é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 Webhook-dokumentáció oldalt, hogy megtudja, hogyan tesztelheti a webhook-URL-címét.

A HMAC SHA256 hashing algoritmus módszerével állítson be egy hitelesítési folyamatot a cél-URL-címe és a FedEx között továbbított információk hitelesítésére.

1. Ha a Létrehozás gombra kattint, a FedEx létrehoz egy véletlenszerű kihívási karakterláncot, amelyet elküld Önnek a kérés szövegtörzsében. Önnek vissza kell küldenie ezt a kihívási karakterláncot a FedExnek a válasz szövegtörzsében.

1. Üzenethitelesítési kód (MAC) inicializálása a HMAC SHA256 algoritmus/eljárás segítségével a kihívási karakterlánc és a biztonsági token (vagy titkos kulcs) kivonatolásához (vagy kombinálásához) egy kivonatoló aláírás létrehozásához

1. Válaszoljon a FedExnek a challengeString- és a challengeStringResponse-adatokkal együtt a válasz szövegtörzsében, a 200 (OK) vagy 202 (ACCEPTED) HTTP-státuszkóddal együtt.

1. A FedEx ezután hitelesíti a kihívási karakterláncot és a kihívási karakterlánc válaszát.

• Miután a FedEx megkapta a válasz szövegtörzsét, a FedEx hitelesíti a challengeStringet és a challengeStringResponse-t (vagy a korábban generált kivonatolási aláírást) azáltal, hogy összehasonlítja a FedEx által generált challengeStringgel és kivonatolási aláírással.

• Amennyiben mind a „challengeString”, mind pedig a HMAC-aláírás egyezik, akkor sikeres volt a hitelesítés és a munkafolyamat. Ellenkező esetben a hitelesítési folyamat sikertelen, és megjelenik az ennek megfelelő hibaüzenet.

Webhookprojekt létrehozása

A Saját projektek oldalon lépjen a Webhookok fülre.

A szervezete valamely rendszergazdája vagy közreműködője létrehozhat webhookprojektet a Webhookprojekt létrehozása gombra kattintva.

A kezdés előtt ossza meg velünk, miért kér hozzáférést a FedEx-webhookokhoz. Megjelenik egy modális ablak, és legördülő listából választhat. Ki kell választania azt a lehetőséget, amelyik a legjobban meghatározza, hogy vállalkozása miért szeretné integrálni a FedEx-webhookokat.

Amennyiben Ön feladóként azonosítja magát, elkezdheti a projektje létrehozását a következő lépések teljesítésével:

1. Azonosítsa üzleti igényeit

• Válassza ki azt a lehetőséget, amelyik a legjobban meghatározza, hogy vállalkozása miért szeretne integrálódni a FedEx-webhookokkal.

1. A szint és a szintek jellemzőinek kiválasztása

• Válassza ki az alap vagy a haladó webhook szintjét a projektjéhez, a projekt igényei alapján.
• A szintválasztását később bármikor szerkesztheti.
• Minden szinthez havi előfizetési díj tartozik.

• Válassza ki a projekthez konfigurálandó funkciókat.
• Később is szerkesztheti a funkcióit.

1. A projektrészletek konfigurálása

• Adjon beazonosítható nevet a projektjének
• Adja meg az előre generált cél-URL-címet és a biztonsági token adatait, amelyek a beállítás előtti hitelesítés során jönnek létre.

Ügyfélszámok kiválasztása

• Válasszon a projektjéhez társítani kívánt (amerikai vagy kanadai) jogosult ügyfélszámok listájából.

  5. Erősítse meg a részleteket és fogadja el a feltételeket

• Ellenőrizze a konfigurált projekt részleteit.
• Olvassa el és fogadja el a Developer Portal licencszerződését, és nyilatkozzon arról, hogy nem áll szándékában terjeszteni az alkalmazását.
• Olvassa el és fogadja el az Árképzési megállapodást.
• Miután rákattint a Projekt létrehozása gombra:

1. Amennyiben a létrehozási kérelmét sikeresen érvényesítette és feldolgozta a rendszer, egy megerősítő képernyőre kerül.

• Amennyiben az érvényesítés sikertelen vagy hibába ütközik, hibaüzenet jelenik meg.

1. A nyomonkövetési webhookprojektjéhez ezután tartozni fog egy rendszer által létrehozott webhook-azonosító, és „Aktív” állapottal jelenik meg.

1. A FedEx Compatible-szolgáltatói szervezetet hoz létre.
2. Fogadja el a meghívót.
3. Hívjon meg felhasználókat a szervezetébe.
4. Válassza ki azokat az API-kat, amelyekre szüksége van a megoldásához.
5. A FedEx projekt(ek)et hoz létre.
6. Építse be az API-kat az alkalmazásába, és szerezzen tanúsítást a Compatible programhoz.
7. A FedEx elindítja a projekt(ek) gyártását.
8. Gyártási titkos kulcs előállítása

• A FedEx létrehoz egy szervezetet, majd meghív egy csapattagot a szervezethez. Ezt a felhasználót a szervezet rendszergazdájának nevezik ki.
• A tanúsítás és az integráció befejezése után könnyedén terjesztheti a megoldást ügyfeleinek.

• Az API integrációs műtermékeihez és dokumentációihoz való hozzáférés érdekében kérjük, fogadja el a meghívót. A meghívás elfogadásához vagy be kell jelentkeznie a FedEx-felhasználói azonosítójával és jelszavával, vagy létre kell hoznia egy újat, ha még nem rendelkezik hitelesítő adatokkal.

• Rendszergazdaként meghívhat minden olyan csapattagot, akinek hozzáférésre van szüksége a projekthez vagy a szervezethez. A különböző szerepkörökről a Szervezetadminisztrációs útmutatóban olvashat.

• Ha a szervezete már létrejött, kérje meg a szervezet rendszergazdáját vagy a FedExet, hogy hívja meg Önt a csatlakozásra. Önnek 24 órája lesz arra, hogy elfogadja a meghívót, de ha ez alatt az idő alatt ezt nem teszi meg, akkor kérheti, hogy küldjék el újra.

• Lépjen az API-katalógusba és állapítsa meg, mely API-k megfelelőek a megoldásához. A FedEx ügyféltechnikai tanácsadója (CTC) és a Compatible-csatornavezető segíthet kiválasztani a megoldáshoz megfelelő API-kat az üzleti igényeknek megfelelően.

• Válasszon ki egy API-t, és ismerje meg az áttekintését, módosításainak naplóit és legfontosabb jellemzőit.

• Olvassa el az API dokumentációját, amelyben további információkat találhat többek között a kérés- és válaszelemekről és a hibaobjektumokról, és amely mintapéldákat is tartalmaz az Ön által kiválasztott nyelven.

• Lépjen vissza a Salesforce-ra, töltse ki a termékinformációs munkalapot (PIW), és sorolja fel azokat a API-kat, amelyeket hozzá szeretne adni a megoldásához.

A PIW jóváhagyását követően a FedEx létrehozza a projekt(ek)et. Minden megoldás minden verziójának külön projektje lesz a FedEx Developer Portalon belül. Ha egy felhasználó nem a szervezet rendszergazdája, akkor meg kell hívni őt az egyes projektek megtekintésére. 

Ekkor a FedEx Compatible csapata a FedEx CTC-vel és a tanúsító csapatokkal együtt technikai bemutatót szervez az Ön csapatával az API-k bemutatása érdekében. A FedEx csapata bemutatja az elérhető új funkciókat és funkcionalitásokat az Ön által használt API-k verziójában. A csapat képes lesz technikai kérdések megválaszolására az API-kkal, az API-teszteléssel és az összes olyan eljárással kapcsolatban, amelyet be kell fejezni az API-k „tanúsítási*” folyamatának megkezdéséhez.

* Tanúsítás – A FedEx Compatible program által meghatározott folyamat, amely biztosítja a program megfelelőségi követelményeinek való megfelelést. A Compatible program tanúsítására van szükség annak biztosításához, hogy az összes Compatible-szolgáltató a FedEx technológiáját a FedEx technológiai és szolgáltatási szabványai szerint hajtsa végre, forgalmazza és terjessze a szállítóknak (ügyfeleknek).

1. A tranzakciók futtatása érdekében most hozzáférhet a API-tesztkulcsához és a titkos tesztkulcsához. Töltse le őket a Projektáttekintés lap „Tesztkulcs” lapjáról.

1. Ügyfélkulcsok létrehozásához a Credential Registration API-t kell használnia, amely egy privát API, és csak az egyes projektek API szakaszában található meg.
2. Miután létrehozott néhány ügyfélkulcsot, kérjen OAuth-hozzáférési tokent minden API-tranzakcióhoz. A lexikális elem munkamenete 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 lexikális elemet. További részleteket az API-k hitelesítésidokumentációja tartalmaz. A mintakód megtekintése során ellenőrizze, hogy a „Viszonteladó” lehetőséget választotta-e a minták legördülő menüjéből.

1. A Tesztelési kulcsok oldalon válassza ki az API-k dokumentációit, és olvassa el az üzleti összefüggéseket, hogy megtudja, miként használandó a kiválasztott API. Tanulmányozza át a kívánt integrációnak megfelelő végponthoz tartozó kérési mintapéldákat.
2. A minta kérésekben leírtak szerint implementálja e végpontok hívásait, konfigurálásukhoz a tesztelési hitelesítő adatait használva.
3. Ellenőrizze, hogy az API-hívásokra kapott válaszok megegyeznek-e a dokumentációban találhatóakkal.
4. Teljesen tesztelje le implementációját a FedEx tesztelési környezetében, tesztelési hitelesítő adatait és a FedEx tesztelési URI-kat használva.
5. A megoldások teljes tesztelése után tanúsítsa az egyes megoldásokat a Salesforce-ban. A FedEx mindent alaposan ellenőriz minden beküldött információt, és a tanúsítás jóváhagyását követően értesíteni fogja Önt.

• A FedEx ezután elindítja a projekt(ek) gyártását.
• Ezután láthatja a termelési API-kulcsát a Projektáttekintés oldal „Gyártási kulcs” lapján.

• A titkos éles környezet kulcsot a Titkos kulcs oszlop alatt található Titkos kulcs generálása hivatkozásra kattintva kell létrehozni.
• A mintaadatokat használva most ismét letesztelheti a megvalósítást a gyártási környezetben.
• Élvezze az új integráció által kínált előnyöket!