Začínáme

Začněte svou integraci jako poskytovatel řešení FedEx Compatible a využijte výhod, které nabízejí rozhraní API společnosti FedEx. Následující pokyny vás provedou každým krokem procesu rozšiřování funkcí a schopností FedEx v rámci vašeho řešení.


Krok 1:

Projděte si rozhraní API a najděte ta, která potřebujete pro svou aplikaci.

  • Přejděte na stránku Katalog API k nalezení správných rozhraní API pro vaši aplikaci.
  • Vyberte rozhraní API a podívejte se na jeho přehled, seznam změn a hlavní funkce.
Snímek obrazovky stránky Přehled cen
  • V dokumentaci API se dozvíte více o prvcích žádosti a odpovědi, příklady ve zvoleném programovacím jazyce, chybové kódy a další.
Snímek obrazovky stránky Cenová dokumentace
  • Projděte si stránku Oznámení s informacemi o plánovaných aktualizacích služeb a o tom, co je nového.

Krok 2:

Zaregistrujte se nebo se přihlaste a začněte integraci s rozhraními FedEx API.

  • Začněte integraci s rozhraními FedEx API tím, že se přihlásíte pomocí svého uživatelského ID fedex.com a hesla.
  • Pokud ještě nemáte uživatelské ID, zaregistrujte se zdarma.

Krok 3:

Vytvořte organizaci nebo se k ní připojte.

Vytvořte organizaci, pokud ještě pro vaši společnost žádná neexistuje, nebo se připojte ke stávající organizaci vaší společnosti. Ke své organizací můžete mít přidruženo více uživatelů, ale nemůžete mít několik organizací přidružených k jednomu uživatelskému ID.

Pokud vytvoříte svou organizaci vy, budete automaticky uveden jako správce této organizace. Správce může pozvat uživatele, aby se připojili k jeho organizaci, přidělit jim role a projekty a může spravovat účty pro zasílání. Chcete-li se dozvědět více o tom, které role jsou pro koho nejlepší, prohlédněte si naše pokyny pro správu organizace (Organization Administration Guidelines). Chcete-li vytvořit svoji vlastní organizaci, klikněte na Moje projekty a poté klikněte na tlačítko „Vytvořit organizaci“. Toto tlačítko se zobrazí, pouze pokud jste doposud nepřidělili své uživatelské ID k existující organizaci. Zde můžete začít vytvářet organizaci vyplněním následujících položek (položky označené hvězdičkou (*) jsou volitelné):

  • Zadejte název organizace.
  • Zadejte e-mailové adresy všech členů týmu, které chcete pozvat. Budou automaticky přidáni jako pozorovatelé a nebudou propojeni s žádnými projekty.*
Snímek obrazovky stránky Vytvořte svou organizaci

Můžete se také připojit do své organizace společnosti provedením následujících kroků:

  • Pokud vaše společnost již organizaci vytvořila, požádejte správce organizace, aby vás do ní pozval. Pozvání má platnost 24 hodin, ale pokud toto časové okno nestihnete, můžete požádat o opětovné zaslání pozvánky.
  • Chcete-li pozvání přijmout, musíte se buď přihlásit pomocí svého stávajícího uživatelského ID a hesla, nebo vytvořit nové, pokud je vaše stávající uživatelské ID již k organizaci přidruženo.

Krok 4:

Přidejte účet pro zasílání.

Správce může v rámci organizace přidat tolik účtů pro zasílání, kolik je potřeba. Chcete-li začít, klikněte na tlačítko „Přidat účet“ na kartě Účty pro zasílání na stránce Spravovat organizaci. Zde můžete do své organizace přidat existující účet pro zasílání provedením následujících kroků:

  1. Vyplňte informace o účtu
  • Zadejte číslo účtu, libovolnou přezdívku účtu a fakturační adresu spojenou s účtem. Tyto údaje budou ověřeny, aby bylo zajištěno, že odpovídají údajům účtu a zabránilo se tak podvodným činnostem.

  • Chcete-li zobrazit účty pro zasílání přidružené k vašemu ID uživatele, přejděte na stránku Administrátor pro přepravu. Chcete-li vytvořit nové účty pro zasílání, kontaktujte obchodního zástupce společnosti FedEx.

Snímek obrazovky stránky Přidat účet pro zasílání
  1. licenční smlouva s koncovým uživatelem
Snímek obrazovky stránky Přijmout smlouvu EULA

Krok 5:

Přidejte uživatele do své organizace a začněte spolupracovat se svými spolupracovníky.

Správce může do své organizace pozvat uživatele a přiřadit jim role a projekty. Chcete-li začít, klikněte na tlačítko „Přidat uživatele“ na kartě Uživatelé na stránce Spravovat organizaci. Zde můžete začít přidávat uživatele vyplněním následujících položek (položky označené hvězdičkou (*) jsou volitelné):

  1. Zadejte e-mailové adresy uživatelů, kteří se potřebují připojit k vaší organizaci. Zadejte více e-mailových adres stisknutím mezery, čárky, středníku nebo klávesy Enter na klávesnici.
  2. Vyberte role uživatelů, pokud výchozí možnost „pozorovatel“ neodpovídá potřebám uživatelů.*
  3. Vyberte projekt přidružený k vaší organizaci, ke kterému uživatele přiřadíte. Pokud jste ještě žádný nevytvořili, jeho vytvoření je popsáno v dalším kroku.*
Snímek obrazovky stránky Přidat uživatele

Správce bude mít vždy přístup ke všem projektům, ale přispěvatel nebo pozorovatel musí být k projektu přiřazen, ledaže by projekt vytvořil přispěvatel. Ať už uživatel pozvání přijal nebo ne, můžete rychle aktualizovat jejich projekty nebo role přímo na kartě Uživatelé na obrazovce Správa organizace. Jediné, co musíte udělat, je kliknout na stříšku vedle role nebo projektu a zobrazí se rozevírací seznam s možnostmi výběru. Vyberte si vhodnou možnost a uložte výběr kliknutím na tlačítko „Použít“.

Snímek obrazovky stránky Spravovat organizaci

Krok 6:

Vytvořte projekt a získejte pověření.

Na stránce Moje projekty může správce nebo přispěvatel vytvořit projekt kliknutím na tlačítko „Vytvořit projekt“. Zde můžete začít vytvářet organizaci vyplněním následujících položek (položky označené hvězdičkou (*) jsou volitelné):

1.  Nastavení projektu        

  • Dejte svému projektu identifikovatelný název, který je v rámci vaší organizace jedinečný.
  • Začněte výběrem alespoň jedno rozhraní API, které chcete přidat do svého projektu. Rozhraní API můžete kdykoli přidat nebo odebrat.           
Snímek obrazovky kroku 1 vytváření projektu 

2. Přijetí podmínek

Snímek obrazovky kroku 2 vytváření projektu
       
         3.  Konfigurace projektu
 
  • 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í balíků 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.*
  • Pokud plánujete používat služby FedEx Ground® Economy Returns nebo FedEx Freight® LTL, vyberte Ano.*
  • Jakmile kliknete na tlačítko „Vytvořit“, zobrazí se vám obrazovka s potvrzením. V rámci nového projektu si nyní můžete prohlédnout své testovací pověření. 
Snímek obrazovky kroku 3 vytváření projektu

Krok 7:

Integrujte API do své aplikace a otestujte svoji implementaci.

  1. Na kartě Testovací klíč na stránce Přehled projektu načtěte testovací pověření (Klíč API, Tajný klíč a účet/účty pro zasílání).
Snímek obrazovky stránky pro testovací klíče
  1. Požádejte o přístupový token OAuth, který musí být 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.
  2. 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.
  3. 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í.
  4. Ověřte, zda přijaté výzvy API odpovídají požadavkům uvedeným v dokumentaci.
  5. Kompletně otestujte implementaci v testovacím prostředí FedEx pomocí testovacích pověření a testovacích URI FedEx.

Krok 8:

Přesuňte svůj projekt do produkční fáze.

Na stránce Přehled projektu klikněte na kartu Produkční klíč. Zde můžete začít vytvářet organizaci vyplněním následujících položek (položky označené hvězdičkou (*) jsou volitelné):

  1. Nakonfigurujte projekt.
  • Přejmenujte svůj Produkční klíč API.*
  • V tuto chvíli je nutné přidat jeden účet pro zasílání, ale po úspěšném přesunu projektu do produkční fáze můžete přidat další. Pokud ke své organizaci nemáte přidružené žádné účty pro zasílání nebo pokud smlouva EULA nebyla pro účty pro zasílání přidané do vaší organizace podepsána, nebudou v rozevíracím seznamu zobrazeny.
Snímek obrazovky stránky kroku 1 pro produkční klíče
  1. Získejte klíče projektu.
  • Dále se zobrazí váš produkční klíč 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ý.
Snímek obrazovky stránky kroku 2 pro produkční klíče

Krok 9:

Dokončete svoji integraci.

  1. Některá API vyžadují pro použití v našem produkčním prostředí buď základní certifikaci, nebo certifikaci přepravního štítku. Dokončete proces certifikace všech API ve svém projektu s tímto požadavkem.
Snímek obrazovky stránky certifikace
  1. Poté, co byla všechna API certifikována a aktivována, aktualizujte své požadavky API nahrazením testovacích URI, klíčů a účtů pro zasílání produkčními URI, klíči a účty 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!


Krok 1: 

Společnost FedEx vytváří organizaci poskytovatelů řešení Compatible.

  • Společnost FedEx vytvoří organizaci a poté pozve jednoho člena týmu, aby se do organizace 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.

Krok 2:

Přijetí pozvánky.

  • 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.
snímek obrazovky stránky Přihlaste se a začněte integraci s rozhraními API společnost FedEx

Krok 3:

Pozvání uživatelů do organizace.

  • 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.
snímek obrazovky stránky Spravovat uživatele 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.

Krok 4:

Výběr rozhraní API pro vaše řešení.

  • Přejděte na stránku Katalog API, která vám pomůže určit ta pravá rozhraní API pro vaše řešení. Váš konzultant CTC FedEx (Customer Technology Consultant) a manažer kanálu Compatible vám pomohou vybrat ta pravá rozhraní API pro vaše řešení a potřeby.

snímek obrazovky stránky Katalog API
  • Vyberte rozhraní API a podívejte se na jeho přehled, seznam změn a hlavní funkce.

snímek obrazovky stránky Přehled rozhraní API pro ověření adresy
  • V dokumentaci k rozhraním API najdete prvky žádostí a odpovědí, příklady ve zvoleném jazyce, chybové objekty a další.

snímek obrazovky stránky Dokumentace k rozhraní API pro ověření adresy
  • 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.


Krok 5:

FedEx vytvoří projekty.

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.


Krok 6:

Integrace rozhraní API do vaší aplikace a certifikace v rámci programu Compatible.

  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.
snímek obrazovky karty 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.
snímek obrazovky rozevíracího seznamu ukázek kódu pro stránku Rozhraní API pro registraci pověření
  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.

Krok 7:

FedEx přesune projekty do produkční fáze.

  • 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.
snímek obrazovky kompatibilní verze se zobrazeným odkazem pro vytvoření pro kartu Produkční klíč na stránce Přehled projektu

Krok 8:

Vygenerování tajného produkčního klíče.

  • Váš tajný produkční klíč vygenerujete kliknutím na odkaz Vygenerovat tajný klíč pod sloupcem 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!