1. Vytvoření projektu a získání pověření
2. Integrace rozhraní API a otestování vlastní implementace
3. Přesun projektu do produkční fáze
4. Dokončení certifikace

Správce nebo přispěvatel organizace může vytvořit projekt rozhraní API kliknutím na tlačítko Vytvořit projekt rozhraní API.

Ještě než začnete, je třeba, abyste nám sdělili, proč potřebujete přístup k rozhraním API společnosti FedEx. Zobrazí se modální okno s rozbalovací nabídkou možností. Měli byste vybrat možnost, která nejlépe odpovídá potřebám vaší společnosti v oblasti integrace s rozhraními API společnosti FedEx.

Pokud se identifikujete jako odesílatel, můžete začít vytvářet svůj projekt. Tento proces se skládá ze tří kroků:

Vybrat rozhraní API

Vyberte rozhraní API, která chcete zahrnout do svého projektu. V závislosti na vybraných rozhraních API možná budete muset provést některé další volby.

Pokud vyberete rozhraní API pro sledování, budete muset také:

• Vybrat číslo účtu, které chcete přidružit ke svému produkčnímu klíči.
• Zkontrolovat kvóty a limity transakčních sazeb rozhraní API a projít si podrobnosti o certifikaci rozhraní API.
• Vybrat, zda se chcete přihlásit k odběru e‑mailových oznámení v případě překročení kvóty transakcí.

Konfigurovat projekt

Zadejte některé údaje o projektu, včetně názvu a provozovny pro zasílání.

• Dejte svému projektu identifikovatelný název, který je v rámci vaší organizace jedinečný.
• Vyberte země, v rámci kterých chcete zasílat zásilky, abychom vám mohli přiřadit testovací účet pro zasílání. Chcete‑li odesílání zásilek testovat vnitrostátně v rámci jedné z evropských zemí, musíte mít pro každou zemi samostatný testovací účet. Země můžete kdykoli přidat/odebrat.
• Chcete‑li si nechat zasílat oznámení o nejnovějších aktualizacích rozhraní API a informace související s výpadky, můžete si nastavit předvolby oznámení.

Potvrzení podrobností

Zkontrolujte podrobnosti projektu a pak přijměte Přepravní podmínky.

• Přečtěte si Licenční smlouvu o užívání vývojářského portálu FedEx Developer Portal, přijměte ji a potvrďte, že nemáte v úmyslu svou aplikaci prodávat nebo distribuovat.
• Jakmile kliknete na tlačítko "Vytvořit", zobrazí se obrazovka s potvrzením. V rámci nového projektu si pak můžete prohlédnout své testovací pověření.

• Požádejte o přístupový token OAuth, který musí být použit u každé transakce rozhraní API. Token je platný pouze hodinu, takže budete muset naprogramovat svou aplikaci tak, aby před vypršením relace token obnovila. Další podrobnosti najdete v Dokumentaci k autorizaci rozhraní API.
• Klikněte na dokumentaci k některému z vašich rozhraní API a přečtěte si obchodní kontext, abyste co nejlépe pochopili, jak vybrané rozhraní API používat. Můžete si také projít příklady požadavků na koncový bod, které odpovídají vaší požadované integraci.
• Implementujte svá volání těchto koncových bodů podle popisu v příkladech požadavků a nakonfigurujte je s použitím svých testovacích pověření.
• Ověřte, zda přijaté odpovědi na volání rozhraní API odpovídají odpovědím uvedeným v dokumentaci.
• Otestujte svou implementaci v testovacím prostředí společnosti FedEx pomocí testovacích pověření a testovacích adres URL společnosti FedEx.

V rámci kroku Konfigurace projektu:

• Podle potřeby můžete svůj klíč přejmenovat.
• Zkontrolujte číslo účtu, které jste vybrali v 1. kroku procesu vytváření projektu. To slouží k přesunu projektu do produkční fáze. Po přesunu projektu do produkční fáze můžete podle potřeby přidat další účty.

V rámci kroku Získání klíčů projektu:

• Zobrazí se váš produkční klíč rozhraní API a tajný produkční klíč. Nezapomeňte je zkopírovat na bezpečné místo.
• Abychom udrželi váš tajný produkční klíč v bezpečí, zobrazíme jej pouze jednou. Pokud jej ztratíte, můžete si vygenerovat nový.
• Klikněte na Další.

Nyní budete přesměrováni zpět na stránku Přehled projektu. Zde můžete přidat další účty přidružené k vašemu projektu.

Na stránce Přehled projektu:

• Klikněte na 3 svislé tečky a přidejte další účty přidružené k vašemu projektu.
• Pak klikněte na Upravit.

Budete přesměrováni na stránku Klíč rozhraní API, kde můžete přidat další účty, které chcete přidružit ke svému produkčnímu klíči pro tento projekt.

1. Některá rozhraní API vyžadují pro použití v našem produkčním prostředí certifikaci přepravního štítku. Dokončete proces certifikace všech rozhraní API ve svém projektu, která mají tento požadavek.

1. Poté, co byla všechna rozhraní API certifikována a aktivována, aktualizujte své požadavky rozhraní API tím, že testovací identifikátory URI, klíče a účty pro zasílání nahradíte produkčními identifikátory URI, klíči a účtem pro zasílání.

2. Opětovně otestujte implementaci v produkčním prostředí pomocí zkušebních dat.

3. Užívejte si výhod vaší nové integrace!

Předpoklady pro vytvoření projektu webhooku

1. Vytvoření platné adresy URL v cílové aplikaci/platformě
2. Vygenerování tokenu zabezpečení
3. Otestování adresy URL webhooku
4. Ověření cílové adresy URL

Vytvoření projektu webhooku

1. Vytvoření projektu webhooku pro příjem nakonfigurovaných oznámení o datových částech

Předpoklady pro vytvoření projektu webhooku

Vytvořte v cílové aplikaci/platformě platnou adresu URL pro příjem ověřovacích kódů/zpráv a sledování oznámení o datových částech webhooků od společnosti FedEx.

Požadavky na adresu URL:

Tento token zabezpečení lze použít jako tajný klíč k ověřování a validaci informací přenášených mezi vámi (zákazníkem) a společností FedEx.

Požadavky na token zabezpečení:

• minimální délka 25 znaků a maximální délka 100 znaků
• 1 velké písmeno
• 1 malé písmeno
• 1 číslice

Otestování adresy URL je volitelný krok, který může být užitečný.

Testováním můžete získat lepší představu o tom, zda je adresa URL, kterou jste vytvořili v 1. kroku, platná. Společnost FedEx může vaši adresu URL identifikovat a vytvořit s ní spojení pro odesílání dat. Testováním lze také získat vzorová testovací data, s jejichž pomocí můžete zkontrolovat a ověřit, zda je vaše aplikace schopna zpracovávat poskytovaná sledovací data. Při testování se však neověřuje vaše adresa URL.

Informace o testování adresy URL webhooku najdete v naší dokumentaci k webhookům.

Pomocí metody hashovacího algoritmu HMAC SHA256 nastavte proces ověřování, který slouží k validaci informací přenášených mezi vaší cílovou adresou URL a společností FedEx.

1. Po kliknutí na tlačítko Vytvořit společnost FedEx vygeneruje náhodný řetězec výzvy, který vám bude zaslán v textu požadavku.Od vás se pak očekává, že tento řetězec výzvy odešlete společnosti FedEx zpět v textu odpovědi.

1. Inicializujte funkci MAC (Message Authentication Code) pomocí algoritmu/procedury HMAC SHA256 a vytvořte podpis hodnoty hash hashováním (nebo kombinací) řetězce výzvy a tokenu zabezpečení (nebo tajného klíče).

1. Odešlete společnosti FedEx odpověď, jejíž text obsahuje hodnoty challengeString a challengeStringResponse spolu se stavovým kódem HTTP 200 (OK) nebo 202 (PŘIJATO).

1. Společnost FedEx nyní ověří řetězec výzvy a vaši odpověď na ni.

• Jakmile společnost FedEx obdrží text odpovědi, ověří hodnoty challengeString a challengeStringResponse (nebo dříve vygenerovaný podpis hodnoty hash) jejich porovnáním s hodnotou challengeString a podpisem hodnoty hash vygenerovaným společností FedEx.

• Pokud hodnota challengeString odpovídá podpisu HMAC, znamená to, že ověření a pracovní postup proběhly úspěšně. V opačném případě proces ověřování selže a zobrazí se příslušná chybová zpráva.

Vytvoření projektu webhooku

Na stránce Moje projekty přejděte na kartu Webhooky.

Správce nebo přispěvatel organizace může vytvořit projekt webhooku kliknutím na tlačítko Vytvořit projekt webhooku.

Ještě než začnete, je třeba, abyste nám sdělili, proč potřebujete přístup k webhookům společnosti FedEx. Zobrazí se modální okno s rozbalovací nabídkou možností. Měli byste vybrat možnost, která nejlépe odpovídá potřebám vaší společnosti v oblasti integrace s webhooky společnosti FedEx.

Pokud se identifikujete jako odesílatel, můžete začít vytvářet svůj projekt provedením následujících kroků:

1. Identifikace vašich obchodních potřeb

• Vyberte možnost, která nejlépe vystihuje důvod, proč vaše firma chce provést integraci s webhooky společnosti FedEx.

1. Výběr úrovně a funkcí úrovně

• Podle potřeb projektu vyberte základní nebo pokročilou úroveň webhooků.
• Výběr úrovně pak můžete kdykoli upravit.
• S každou úrovní se pojí určitá výše měsíčního předplatného.

• Vyberte funkce, které chcete pro svůj projekt nakonfigurovat.
• Funkce můžete upravit i později.

1. Konfigurace podrobností o projektu

• Dejte svému projektu identifikovatelný název.
• Zadejte podrobnosti o předem vygenerované cílové adrese URL a tokenu zabezpečení, které se vytvoří během ověřování před nastavením.

Výběr účtů

• Vyberte ze seznamu způsobilých (amerických nebo kanadských) čísel účtů ta, která chcete přiřadit ke svému projektu.

  5. Potvrzení podrobností a přijetí podmínek

• Zkontrolujte nakonfigurované podrobnosti o projektu.
• Přečtěte si Licenční smlouvu o užívání vývojářského portálu Developer Portal, přijměte ji a potvrďte, že nemáte v úmyslu svou aplikaci distribuovat.
• Přečtěte si a přijměte Smlouvu o cenách.
• Po kliknutí na tlačítko Vytvořit projekt:

1. Pokud byl váš požadavek na vytvoření úspěšně ověřen a zpracován, budete přesměrováni na obrazovku s potvrzením.

• Pokud ověření neproběhne úspěšně nebo selže, zobrazí se chybová zpráva.

1. Váš projekt webhooku sledování pak bude mít systémem vygenerované ID webhooku a zobrazí se ve stavu "Aktivní".

1. Společnost FedEx vytváří organizaci poskytovatelů řešení Compatible.
2. Přijetí pozvánky.
3. Pozvání uživatelů do organizace.
4. Výběr rozhraní API pro vaše řešení.
5. FedEx vytvoří projekty.
6. Integrace rozhraní API do vaší aplikace a certifikace v rámci programu Compatible.
7. FedEx přesune projekty do produkční fáze.
8. Vygenerování tajného produkčního klíče.

• Společnost FedEx vytvoří organizaci a poté pozve jednoho člena týmu, aby se k organizaci připojil. Tento uživatel bude pro vaši organizaci určen jako správce.
• Po dokončení certifikace a integrace budete moci snadno distribuovat řešení zákazníkům.

• Chcete-li získat přístup k artefaktům a dokumentaci pro integraci rozhraní API, přijměte pozvánku. Chcete-li pozvánku přijmout, musíte se přihlásit pomocí uživatelského ID FedEx a hesla nebo vytvořit nové, pokud dosud nemáte přihlašovací údaje.

• Jako správce můžete poslat pozvánku všem členům týmu, kteří potřebují přístup k projektu nebo organizaci. Chcete-li získat podrobnosti o různých rolích, prohlédněte si naši příručku pro správu organizace.

• Pokud vaše organizace již byla vytvořena, požádejte správce organizace nebo společnost FedEx, aby vás do ní pozvali. Pozvání má platnost 24 hodin, ale pokud toto časové okno nestihnete, můžete požádat o opětovné zaslání pozvánky.

• Přejděte do Katalogu rozhraní API, který vám pomůže najít ta správná rozhraní API pro vaše řešení. Váš konzultant zákaznických technologií FedEx (Customer Technology Consultant) a manažer zodpovědný za kompatibilní řešení vám pomohou vybrat ta správná rozhraní API pro vaše řešení a potřeby.

• Vyberte rozhraní API a podívejte se na jeho přehled, seznam změn a hlavní funkce.

• V dokumentaci k rozhraním API najdete prvky žádostí a odpovědí, příklady ve zvoleném jazyce, chybové objekty a další.

• Přejděte zpět na Salesforce, vyplňte pracovní list PIW (Product Information Worksheet) a uveďte rozhraní API, která chcete ke svému řešení přidat.

Po schválení pracovního listu PIW společnost FedEx vytvoří vaše projekty. Každá verze každého řešení bude mít samostatný projekt v rámci portálu FedEx Developer Portal. Pokud není uživatel správcem organizace, musí být pozváni, aby mohli zobrazit každý projekt. 

V tuto chvíli také tým FedEx Compatible spolu s konzultantem FedEx CTC a týmy certifikace zorganizují technickou ukázku rozhraní API pro váš tým. Tým FedEx představí nové funkce dostupné ve verzi rozhraní API, kterou jste si vybrali. Tým zodpoví technické otázky ohledně rozhraní API, testování rozhraní API a všech procesů,, které musí být dokončeny, před zahájením procesu certifikace* pro rozhraní API.

* Certifikace – proces definovaný v programu FedEx Compatible pro splnění požadavků programového souladu. Certifikace programového souladu je vyžadována pro zajištění toho, aby všichni poskytovatelé řešení Compatible implementovali a distribuovali technologii společnosti FedEx odesílatelům (zákazníkům) v souladu se standardy technologie a služeb společnosti FedEx.

1. Nyní budete mít přístup k testovacímu klíči API a tajnému testovacímu klíči pro provádění transakcí. Najdete je na kartě Testovací klíč na stránce Přehled projektu.

1. Chcete-li vytvořit klíče zákazníků, musíte použít rozhraní API pro registraci pověření, což je soukromé rozhraní API, které najdete pouze v části API každého projektu.
2. Po vytvoření několika klíčů zákazníků můžete požádat o přístupový token OAuth pro použití u každé transakce API. Relace tokenu je platná pouze hodinu, takže před vypršením relace budete muset naprogramovat kódem svou aplikaci pro obnovení tokenu. Další podrobnosti naleznete v dokumentaci rozhraní API pro autorizaci. Při zobrazování ukázek kódu se ujistěte, že je v rozevíracím seznamu vybrána volba Reseller.

1. Vyberte dokumentaci rozhraní API na stránce Testovací klíče a přečtěte si obchodní kontext, abyste co nejlépe pochopili, jak vybrané rozhraní API používat. Přečtěte si příklady požadavků na koncový bod, které odpovídají vaší požadované integraci.
2. Implementujte své výzvy na tyto koncové body, jak je popsáno v příkladech požadavků, a nakonfigurujte je tak, aby používaly vaše testovací pověření.
3. Ověřte, zda přijaté výzvy API odpovídají požadavkům uvedeným v dokumentaci.
4. Kompletně otestujte implementaci v testovacím prostředí FedEx pomocí testovacích pověření a testovacích URI FedEx.
5. Po dokončení testování řešení certifikujte každé řešení v části Salesforce. Společnost FedEx zkontroluje všechny odeslané položky a bude vás informovat, až bude vaše certifikace schválena.

• Společnost FedEx poté přesune vaše projekty do produkční fáze.
• Poté budete moci zobrazit produkční klíč API na kartě Produkční klíč na stránce Přehled projektu.

• Váš tajný produkční klíč vygenerujete kliknutím na odkaz Vygenerovat tajný klíč ve sloupci Tajný klíč.
• Nyní budete moci opětovně otestovat implementaci v produkčním prostředí pomocí zkušebních dat.
• Užívejte si výhod vaší nové integrace!