Začínáme
Portál FedEx Developer Portal nabízí sadu aplikačních programových rozhraní (API) pro integraci společnosti FedEx do vašich aplikací. Tyto pokyny vám pomohou nastavit organizaci, vytvořit projekt, otestovat integraci, přesunout projekt do produkční fáze a v některých případech ověřit rozhraní API.
Typy uživatelů:
FedEx nabízí integrační služby třem typům uživatelů: odesílatelům FedEx, ověřeným softwarovým řešením (poskytovatelům kompaktního řešení) a poskytovatelům nekompaktního řešení.
Odesílatel FedEx:
Společnost, která využívá přepravu přes FedEx a potřebuje integrovat FedEx API do svých vlastních aplikací.
Poskytovatel řešení nebo služeb:
Společnost, která potřebuje integrovat FedEx API za účelem vytvoření řešení, aplikace nebo pluginu, které lze prodávat a/nebo distribuovat externí organizaci,která využívá služby společnosti FedEx. Vyhledáním v našem globálním adresáři zjistíte, zda je vaše společnost ověřeným poskytovatelem FedEx.
- Poskytovatel kompaktního řešení FedEx: Ověřená společnost se smluvní dohodou prostřednictvím programu FedEx Compatible.
- Poskytovatel nekompaktního řešení: Řešení nebo služba nejsou ověřeny programem FedEx Compatible.
Níže vyberte možnost, která nejlépe vystihuje vaši společnost. Bez ohledu na to, jaký typ uživatele jste, je pro vás připraven průvodní program.
Začínáme.
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.
Vytvoření nové organizace
Chcete‑li vytvořit vlastní organizaci, klikněte na Vytvořit organizaci v levém navigačním panelu. Pokud vytvoříte organizaci, budete automaticky uvedeni 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 (např. přispěvatele nebo pozorovatele) a projekty a může spravovat účty pro zasílání.
- Chcete‑li se o těchto rolích dozvědět více, projděte si naše Pokyny pro správu organizace.
Zadání informací o organizaci
Zadejte název a adresu URL webových stránek vaší společnosti a vytvořte název organizace. Dejte organizaci název, který ostatní uživatelé rozpoznají. Tento název lze použít k dělení společnosti do konkrétnějších skupin (např. oddělení, divize, region, pobočka) nebo může být shodný s názvem vaší společnosti.
Po vytvoření organizace můžete jako správce kliknout na Správa organizace v levém navigačním panelu a zadat další podrobnosti.
Přidat účet pro zasílání
Otevřete kartu Účty pro zasílání. Klikněte na tlačítko Přidat účet.
- Zadejte své stávající číslo účtu, přezdívku účtu a fakturační adresu spojenou s účtem. Ověříme fakturační adresu, abychom se ujistili, že odpovídá údajům o účtu, a zabránili tak podvodům. Pokud nemáte účet FedEx, založte si nový účet nebo se obraťte na zástupce společnosti FedEx.
- Přijměte Licenční smlouvu s koncovým uživatelem nebo ji odešlete jiné osobě v rámci vaší společnosti, která může smlouvu přijmout.
Přidat fakturační účet
Otevřete kartu Fakturační účty. Klikněte na tlačítko Přidání fakturačního účtu k vaší organizaci.
- Zadejte své stávající číslo účtu, přezdívku účtu a fakturační adresu v USA spojenou s účtem. Ověříme fakturační adresu, abychom se ujistili, že odpovídá údajům o účtu, a zabránili tak podvodům. Pokud nemáte účet FedEx, založte si nový účet nebo se obraťte na zástupce společnosti FedEx. Fakturační účty musí mít jako zemi uvedeny USA.
- Přijměte Licenční smlouvu s koncovým uživatelem nebo ji odešlete jiné osobě v rámci vaší společnosti, která může smlouvu přijmout.
Pozvat uživatele
Správce může do své organizace pozvat uživatele a přiřadit jim role a projekty. Otevřete kartu „Uživatelé“. Klikněte na tlačítko „Přidat uživatele“.
- Vyberte uživatelskou roli: Pozorovatel, Přispěvatel nebo Správce.
- Pokud máte nějaké existující projekty, přiřaďte uživateli projekt. Uživatele můžete k projektům přiřadit také na libovolné stránce s přehledem projektů.
- Zadejte e-mailové adresy uživatelů, kteří se mají připojit k vaší organizaci pod vybranou rolí.
Připojte se k existující organizaci
Krok 1: Požádejte správce vaší organizace, aby vám poslal pozvánku.
Pokud vaše společnost již organizaci vytvořila, požádejte správce organizace, aby vás do ní pozval. Pozvánka má platnost 24 hodin. Pokud to v tomto časovém intervalu nestihnete, můžete kdykoli požádat o opětovné zaslání pozvánky.
Krok 2: Přijměte pozvánku.
Chcete‑li pozvánku 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 nějaké organizaci přidruženo.
Vytvořit projekt API
Na stránce Moje projekty otevřete kartu Rozhraní API. Klikněte na tlačítko Vytvořit projekt rozhraní API.
Krok 1: Vyberte rozhraní API, která chcete zahrnout do svého projektu
Zkontrolovat kvóty a limity transakčních sazeb rozhraní API a projít si podrobnosti o ověření rozhraní API.
Krok 2: Konfigurace podrobností o projektu
- 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, nastavte si předvolby oznámení.
Krok 3: Přečtěte si a přijměte podmínky, včetně licenční smlouvy FedEx Developer Portal
Po přijetí podmínek a kliknutí na tlačítko „Vytvořit“ se zobrazí obrazovka s potvrzením. V rámci nového projektu si pak můžete prohlédnout své testovací pověření.
Vytvoření projektu webhooku
Vytvoření platné adresy URL (pro zpětné volání) v cílové aplikaci nebo platformě
Vaše cílová adresa URL bude sloužit k přijímání ověřovacích kódů a zpráv, jakož i oznámení o datovém obsahu webhooku společnosti FedEx. Pro zajištění bezpečnosti musí vaše adresa URL používat protokol HTTPS. Vaše adresa URL bude zablokována, pokud zahrnuje:
- adresní prostor IP adres RFC1918
- doménu fedex.com nebo některou z jejích subdomén
- IP adresy v adrese URL (včetně localhost, 127.0.0.1)
Vygenerování tokenu zabezpečení
Tento token zabezpečení lze použít jako tajný klíč k ověřování a validaci informací přenášených mezi vaší organizací a společností FedEx. Váš token zabezpečení musí obsahovat:
- Minimální délka 26 znaků a maximální délka 100 znaků
- 1 velké písmeno
- 1 malé písmeno
- 1 číslice
Příklad: Y1F6OiVUQW2JPSElmRE9U0IY5
Po definování adresy URL a tokenu zabezpečení můžete vytvořit projekt webhooku. Na stránce Moje projekty otevřete kartu Webhooky. Klikněte na tlačítko Vytvořit projekt webhooku.
Vyberte typ předplatného
Odesílatelé FedEx mohou svá předplatná přihlásit k číslům účtů nebo sledovacím číslům.
Krok 1: Potvrzení vašeho fakturačního účtu a výběr funkcí
- Zkontrolujte uvedený výchozí fakturační účet a potvrďte jej nebo vyberte jiný účet vaší organizace.
- Nakonfigurujte svůj projekt výběrem možností jako jsou potvrzení o doručení, odhadovaná doba doručení, sledování událostí a filtrování na základě událostí.
Krok 2: Zadání podrobností o projektu
- Dejte svému projektu identifikovatelný název, který je v rámci vaší organizace jedinečný.
- Zadejte cílovou adresu URL a údaje o tokenu zabezpečení, které jste vytvořili během ověřování před nastavením (viz kroky výše).
- Chcete-li být informováni o nejnovějších aktualizacích webhooku a o všech informacích souvisejících s výpadky, zadejte e-mailovou adresu a preferovaný jazyk.
Krok 3: Přečtení a přijetí podmínek
Jakmile přijmete podmínky včetně licenční smlouvy FedEx Developer Portal a objednávkového formuláře a kliknete na tlačítko „Vytvořit“, zobrazí obrazovka s potvrzením.
V závislosti na zvoleném typu předplatného se mohou objevit další kroky. Podívejte se na dokumentaci a dozvíte se více.
Na stránce Přehled projektu rozhraní API na kartě Testovací klíč načtěte testovací pověření (klíč rozhraní API a tajný klíč) a účty odesílatele.
Krok 1: Požádejte o přístupový token OAuth
Přístupový token OAuth 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.
Krok 2: Projděte si dokumentaci k rozhraní API
Kliknutím na dokumentaci ke každému z rozhraní API si můžete přečíst obchodní souvislosti a pochopit, jak vybrané rozhraní API používat. Přihlaste se a stáhněte si kolekci JSON API pomocí tlačítka v horní části stránky s dokumentací. Můžete si také projít příklady požadavků na koncový bod, které odpovídají vaší požadované integraci.
Krok 3: Použití sandboxu k testování vzorových transakcí
Kliknutím na požadovaný koncový bod v levé části navigačního panelu přejdete do konkrétního sandboxu. Identifikujte vzorové požadavky, které odpovídají vašemu případu použití, a poté použijte své testovací pověření a testovací adresy URL společnosti FedEx k implementaci výzev koncového bodu, jak je popsáno v příkladových požadavcích. Ověřte, zda přijaté odpovědi na volání rozhraní API odpovídají odpovědím uvedeným v dokumentaci. Další informace o našich zkušenostech s testováním najdete v Průvodci virtualizací Sandboxu.
Testování pomocí webhooků
Testováním můžete získat lepší představu o tom, zda je adresa URL, kterou jste vytvořili, 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.
Na stránce Přehled projektu otevřete kartu Produkční klíč. Projekty na základě předplatného čísla účtu Advanced Integrated Visibility není třeba přesouvat do produkční fáze.
Krok 1: Konfigurace projektu
- Podle potřeby přejmenujte svůj klíč.
- 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.
Krok 2: Získat klíče projektu
Zkopírujte svůj produkční klíč rozhraní API a tajný produkční klíč se zobrazí na bezpečném místě. Abychom udrželi váš tajný produkční klíč v bezpečí, zobrazíme jej pouze jednou. Pokud jej ztratíte, můžete si vygenerovat nový.
Po získání klíčů projektu a kliknutí na tlačítko Další se na kartě Produkční klíč zobrazí podrobnosti o projektu.
- Chcete-li do projektu přidat další účty pro zasílání, klikněte na Upravit v horní části tabulky účtů pro zasílání.
Některá rozhraní API vyžadují pro použití v našem produkčním prostředí ověření přepravního štítku. Zjistěte, zda vaše rozhraní API vyžaduje ověření.
Krok 1: Vytvořte a otestujte FedEx API se svou webovou aplikací
Jakmile dokončíte vývoj své webové aplikace, je načase dokončit testování pomocí testovacího pověření (testovací účet/účty pro zasílání, klíč API a tajný klíč). Váš testovací klíč API a tajný klíč budou zobrazeny na stránce Přehled projektu a lze je zde kdykoli najít.
Krok 2: Přesuňte svůj projekt do produkční fáze
Po testování pomocí rozhraní API FedEx je třeba zahájit proces ověření přesunutím projektu do produkční fáze na portálu FedEx Developer Portal. Po úspěšném dokončení tohoto kroku se vám zobrazí váš produkční klíč API a tajný klíč. Tajný klíč vám bude zobrazen pouze jednou, ale budete jej moci později vygenerovat znovu.
Krok 3: Vyplňte krycí list štítku
Vyplňte všechny položky Krycího listu štítků s využitím příslušných kontaktních údajů a také informací o tom, jaké služby plánujete implementovat. Uveďte své číslo účtu a produkční klíč.
Krok 4: Vygenerujte a zašlete testovací štítky týmu pro analýzu čárových kódů
Vygenerujte testovací štítky v testovacím prostředí FedEx přidruženém k aplikaci a poté testovací štítky odešlete týmu/týmům pro hodnocení štítků FedEx ke schválení. Tým pro analýzu čárových kódů vyžaduje pro vyhodnocení štítků tři pracovní dny.
Abyste se vyhnuli zpoždění při zpracování, dodržujte tyto osvědčené postupy:
- Štítky musí být vytištěny a naskenovány v rozlišení alespoň 600 DPI. NEZASÍLEJTE SOUBORY VYGENEROVANÉ POMOCÍ API.
- U termálních tiskáren musí být typ obrázku štítku vyžadován v souladu s modelem tiskárny. Příklad: Pro tiskárny Zebra se jedná o typ ZPLII
- Při vytváření vzorových štítků pro vyhodnocení použijte informace o adrese odesílatele/příjemce. Vytvářejte pouze vzorové štítky pro konkrétní služby, o které se žádá.
- FedEx® štítek Platba při doručení (Dobírka) musí obsahovat také odpovídající hodnotu dobírky. Štítek pro vrácení.
- Zásilky FedEx International Express® musí obsahovat také štítek pomocného/sekundárního leteckého nákladního listu (AWB).
- Vícekusé zásilky (MPS) musí obsahovat jeden štítek pro každý balík v zásilce.
- Krycí list štítků zašlete e-mailem jako soubor PDF na adresu: label@fedex.com.
- Fyzické štítky lze zaslat na níže uvedenou adresu:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Pokud naskenované štítky nemají viditelné vady (například čáry procházející čárovým kódem, inkoustové skvrny nebo fyzické poškození), kontrolou projdou a schválení vám bude uděleno.
Při odesílání fyzických štítků věnujte pozornost kvalitě tisku a náhodnému zvětšení/zmenšení štítků (tj. měřítku). Jsou to dva hlavní důvody, proč štítky procesem hodnocení štítků neprojdou.
Krok 5: Přezkoumejte hodnocení štítků
Tým pro analýzu čárových kódů vyhodnotí předložené testovací štítky a buď je schválí, nebo je odmítne. Tým pro analýzu čárových kódů vás ohledně schválení nebo odmítnutí předložených štítků bude kontaktovat. Pokud jsou štítky schváleny, pokračujte k dalšímu kroku. Pokud jsou štítky odmítnuty, opravte štítky dle pokynů a znovu je odešlete ke schválení.
Krok 6: Povolte aplikaci
Poté, co jsou zkušební štítky během produkční fáze schváleny týmem pro analýzu čárových kódů, tým autorizuje vaše produkční pověření k přenosu identifikované transakce přepravního štítku a prostřednictvím e-mailu vás informuje o úspěšném ověření. Vaše schválení se vztahuje vždy jen na konkrétní projekt.
Krok 7: Nahraďte URL a pověření
Nahraďte testovací URL a testovací pověření produkční URL a produkčními pověřeními. Opětovně otestujte implementaci v produkčním prostředí pomocí zkušebních dat.
Krok 1: Přijetí pozvánky ke vstupu do organizace
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.
Krok 2: Přijměte pozvánku
Chcete‑li pozvánku 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 nějaké organizaci přidruženo.
Krok 3: Pozvěte uživatele
Správce může do své organizace pozvat uživatele a přiřadit jim role a projekty. Otevřete kartu „Uživatelé“. Klikněte na tlačítko „Přidat uživatele“.
- Vyberte uživatelskou roli: Pozorovatel, Přispěvatel nebo Správce. Více informací o rolích najdete v našich Pokynech pro správu organizace.
- Pokud máte nějaké existující projekty, přiřaďte uživateli projekt. Uživatele můžete k projektům přiřadit také na libovolné stránce s přehledem projektů.
- Zadejte e-mailové adresy uživatelů, kteří se mají připojit k vaší organizaci pod vybranou rolí.
Přejděte do Katalogu rozhraní API, který vám pomůže najít ta správná rozhraní API nebo webhooky 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.
Krok 1: Vyplnění pracovního listu PIW
Vraťte se do Compatible Provider Community (CPC) a vyplňte pracovní list Product Information Worksheet (PIW).
Krok 2: Kontrola projektů vytvořených společností FedEx
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.
Krok 3: Zúčastněte se s týmem ukázky rozhraní API
Tým FedEx Compatible spolu s konzultantem FedEx CTC a týmy ověření zorganizují technickou ukázku rozhraní API pro váš tým. Tým FedEx bude diskutovat o ověřování kompatibilních programů, nových funkcích a vlastnostech rozhraní API a bude odpovídat na dotazy.
Na stránce Přehled projektu rozhraní API na kartě Testovací klíč načtěte testovací pověření (klíč rozhraní API a tajný klíč).
Krok 1: Vytvoření klíčů zákazníka
K vytvoření klíčů zákazníka použijte rozhraní API pro registraci pověření. Jedná se o neveřejné rozhraní API, které najdete pouze v části rozhraní API v dolní části stránky Přehled projektů API.
Krok 2: Požádejte o přístupový token OAuth
Přístupový token OAuth 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. Při zobrazování ukázek kódu se ujistěte, že je v rozevíracím seznamu vybrána volba Reseller.
Krok 3: Projděte si dokumentaci k rozhraní API
Kliknutím na dokumentaci ke každému z rozhraní API si můžete přečíst obchodní souvislosti a pochopit, jak vybrané rozhraní API používat. Přihlaste se a stáhněte si kolekci JSON API pomocí tlačítka v horní části stránky s dokumentací. Můžete si také projít příklady požadavků na koncový bod, které odpovídají vaší požadované integraci.
Krok 4: Použití sandboxu k testování vzorových transakcí
Kliknutím na požadovaný koncový bod v levé části navigačního panelu přejdete do konkrétního sandboxu. Identifikujte vzorové požadavky, které odpovídají vašemu případu použití, a poté použijte své testovací pověření a testovací adresy URL společnosti FedEx k implementaci výzev koncového bodu, jak je popsáno v příkladových požadavcích. Ověřte, zda přijaté odpovědi na volání rozhraní API odpovídají odpovědím uvedeným v dokumentaci. Další informace o našich zkušenostech s testováním najdete v Průvodci virtualizací Sandboxu.
Krok 5: Ověření každého řešení
Po úplném otestování řešení předložte ověřovacímu týmu testovací případy k ověření každého řešení. Společnost FedEx zkontroluje všechny odeslané položky a bude vás informovat, až bude vaše ověření schváleno.
Testování pomocí webhooků
Pokud má vaše organizace přístup k webhooku, může vám testování pomoci získat lepší představu o tom, zda je vytvořená adresa URL 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.
Společnost FedEx poté přesune vaše projekty do produkční fáze. Na stránce Přehled projektu rozhraní API otevřete kartu Produkční klíč. Klikněte na odkaz Generovat tajný klíč ve sloupci Tajný klíč.
Nyní budete moci opětovně otestovat implementaci v produkčním prostředí pomocí zkušebních dat.
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.
Vytvoření nové organizace
Chcete‑li vytvořit vlastní organizaci, klikněte na Vytvořit organizaci v levém navigačním panelu. Pokud vytvoříte organizaci, budete automaticky uvedeni jako správce této organizace.
- Správce může pozvat uživatele, aby se připojili k jeho organizaci, a přidělit jim role (např. přispěvatel nebo pozorovatel) a projekty.
- Chcete‑li se o těchto rolích dozvědět více, projděte si naše Pokyny pro správu organizace.
Krok 1: Zadání informací o organizaci
- Zadejte název společnosti, adresu URL webových stránek a firemní e-mail pro ověření.
- Vytvořte název organizace. Dejte organizaci název, který ostatní uživatelé rozpoznají. Tento název lze použít k dělení společnosti do konkrétnějších skupin (např. oddělení, divize, region, pobočka) nebo může být shodný s názvem vaší společnosti.
- Zadejte informace o místě, kde vaše společnost sídlí a kde plánujete prodávat nebo distribuovat své softwarové řešení.
Krok 2: Přidání a ověření účtu
Zadejte své stávající číslo účtu, přezdívku účtu a fakturační adresu spojenou s účtem. Ověříme fakturační adresu, abychom se ujistili, že odpovídá údajům o účtu, a zabránili tak podvodům. Pokud nemáte účet FedEx, založte si nový účet nebo se obraťte na zástupce společnosti FedEx.
- Jako poskytovatel třetí strany, který vstupuje do programu FedEx Integrator, musí účet použitý pro tuto počáteční registraci patřit vám jako integrátorovi. Použití účtu koncového zákazníka není povoleno.
- Tento účet bude nastaven jako výchozí fakturační účet pro vaši organizaci.
Krok 3: Přečtení a přijetí podmínek
Po přijetí smlouvy s vývojářem a programové příručky se zobrazí obrazovka s potvrzením. Jako správce nové organizace pak můžete kliknout na možnost Správa organizace v levém navigačním panelu a zobrazit nebo upravit podrobnosti.
Krok 4: Pozvěte uživatele
Správce může do své organizace pozvat uživatele a přiřadit jim role a projekty. Otevřete kartu „Uživatelé“. Klikněte na tlačítko „Přidat uživatele“.
- Vyberte uživatelskou roli: Pozorovatel, Přispěvatel nebo Správce.
- Pokud máte nějaké existující projekty, přiřaďte uživateli projekt. Uživatele můžete k projektům přiřadit také na libovolné stránce s přehledem projektů.
- Zadejte e-mailové adresy uživatelů, kteří se mají připojit k vaší organizaci pod vybranou rolí.
Připojte se k existující organizaci
Krok 1: Požádejte správce vaší organizace, aby vám poslal pozvánku.
Pokud vaše společnost již organizaci vytvořila, požádejte správce organizace, aby vás do ní pozval. Pozvánka má platnost 24 hodin. Pokud to v tomto časovém intervalu nestihnete, můžete kdykoli požádat o opětovné zaslání pozvánky.
Krok 2: Přijměte pozvánku.
Chcete‑li pozvánku 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 nějaké organizaci přidruženo.
Na stránce Moje projekty otevřete kartu Rozhraní API. Klikněte na tlačítko Vytvořit projekt rozhraní API.
Krok 1: Vyberte rozhraní API, která chcete zahrnout do svého projektu
Zkontrolujte kvóty pro odesílání, sazby a další kvóty rozhraní API, limity transakčních sazeb a podrobnosti o ověření rozhraní API.
- Pokud vyberete rozhraní API Ship nebo Open Ship, bude automaticky vybráno rozhraní API dostupnosti služby a rozhraní API pro nahrávání obchodních dokumentů, protože se jedná o základní rozhraní API, která je třeba používat při použití rozhraní API Ship nebo Open Ship.
Krok 2: Konfigurace podrobností o projektu
Dejte svému projektu identifikovatelný název, který je v rámci vaší organizace jedinečný.
Krok 3: Přečtěte si a přijměte podmínky, včetně licenční smlouvy FedEx Developer Portal
Po přijetí podmínek a kliknutí na tlačítko „Vytvořit“ se zobrazí obrazovka s potvrzením. V rámci nového projektu si pak můžete prohlédnout své testovací pověření.
Vytvoření projektu webhooku
Vytvoření platné adresy URL (pro zpětné volání) v cílové aplikaci nebo platformě
Vaše cílová adresa URL bude sloužit k přijímání ověřovacích kódů a zpráv, jakož i oznámení o datovém obsahu webhooku společnosti FedEx. Pro zajištění bezpečnosti musí vaše adresa URL používat protokol HTTPS. Vaše adresa URL bude zablokována, pokud zahrnuje:
- adresní prostor IP adres RFC1918
- doménu fedex.com nebo některou z jejích subdomén
- IP adresy v adrese URL (včetně localhost, 127.0.0.1)
Vygenerování tokenu zabezpečení
Tento token zabezpečení lze použít jako tajný klíč k ověřování a validaci informací přenášených mezi vaší organizací a společností FedEx. Váš token zabezpečení musí obsahovat:
- Minimální délka 26 znaků a maximální délka 100 znaků
- 1 velké písmeno
- 1 malé písmeno
- 1 číslice
Příklad: Y1F6OiVUQW2JPSElmRE9U0IY5
Po definování adresy URL a tokenu zabezpečení můžete vytvořit projekt webhooku. Na stránce Moje projekty otevřete kartu Webhooky. Klikněte na tlačítko Vytvořit projekt webhooku.
Vyberte typ předplatného
Odesílatelé FedEx mohou svá předplatná přihlásit k číslům účtů nebo sledovacím číslům.
Krok 1: Potvrzení vašeho fakturačního účtu a výběr funkcí
- Zkontrolujte uvedený výchozí fakturační účet a potvrďte jej nebo vyberte jiný účet vaší organizace.
- Nakonfigurujte svůj projekt výběrem možností jako jsou potvrzení o doručení, odhadovaná doba doručení, sledování událostí a filtrování na základě událostí.
Krok 2: Zadání podrobností o projektu
- Dejte svému projektu identifikovatelný název, který je v rámci vaší organizace jedinečný.
- Zadejte cílovou adresu URL a údaje o tokenu zabezpečení, které jste vytvořili během ověřování před nastavením (viz kroky výše).
- Chcete-li být informováni o nejnovějších aktualizacích webhooku a o všech informacích souvisejících s výpadky, zadejte e-mailovou adresu a preferovaný jazyk.
Krok 3: Přečtení a přijetí podmínek
Jakmile přijmete podmínky včetně licenční smlouvy FedEx Developer Portal a objednávkového formuláře a kliknete na tlačítko „Vytvořit“, zobrazí obrazovka s potvrzením.
V závislosti na zvoleném typu předplatného se mohou objevit další kroky. Podívejte se na dokumentaci a dozvíte se více.
Na stránce Přehled projektu rozhraní API na kartě Testovací klíč načtěte testovací pověření (klíč rozhraní API a tajný klíč).
Krok 1: Požádejte o přístupový token OAuth
Přístupový token OAuth 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.
Krok 2: Projděte si dokumentaci k rozhraní API
Kliknutím na dokumentaci ke každému z rozhraní API si můžete přečíst obchodní souvislosti a pochopit, jak vybrané rozhraní API používat. Přihlaste se a stáhněte si kolekci JSON API pomocí tlačítka v horní části stránky s dokumentací. Můžete si také projít příklady požadavků na koncový bod, které odpovídají vaší požadované integraci.
Krok 3: Použití sandboxu k testování vzorových transakcí
Kliknutím na požadovaný koncový bod v levé části navigačního panelu přejdete do konkrétního sandboxu. Identifikujte vzorové požadavky, které odpovídají vašemu případu použití, a poté použijte své testovací pověření a testovací adresy URL společnosti FedEx k implementaci výzev koncového bodu, jak je popsáno v příkladových požadavcích. Ověřte, zda přijaté odpovědi na volání rozhraní API odpovídají odpovědím uvedeným v dokumentaci. Další informace o našich zkušenostech s testováním najdete v Průvodci virtualizací Sandboxu.
Testování pomocí webhooků
Pokud má vaše organizace přístup k webhooku, může vám testování pomoci získat lepší představu o tom, zda je vytvořená adresa URL 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.
Na stránce Přehled projektu otevřete kartu Produkční klíč. Projekty na základě předplatného čísla účtu Advanced Integrated Visibility není třeba přesouvat do produkční fáze.
Krok 1: Konfigurace projektu
Podle potřeby přejmenujte svůj klíč.
Krok 2: Získat klíče projektu
Zkopírujte svůj produkční klíč rozhraní API a tajný produkční klíč se zobrazí na bezpečném místě. Abychom udrželi váš tajný produkční klíč v bezpečí, zobrazíme jej pouze jednou. Pokud jej ztratíte, můžete si vygenerovat nový.
Po získání klíčů projektu a kliknutí na tlačítko Další se na kartě Produkční klíč zobrazí podrobnosti o projektu.
Některá rozhraní API vyžadují pro použití v našem produkčním prostředí ověření přepravního štítku. Zjistěte, zda vaše rozhraní API vyžaduje ověření.
Krok 1: Vytvořte a otestujte FedEx API se svou webovou aplikací
Jakmile dokončíte vývoj své webové aplikace, je načase dokončit testování pomocí testovacího pověření (testovací klíč API a tajný klíč). Váš testovací klíč API a tajný klíč budou zobrazeny na stránce Přehled projektu a lze je zde kdykoli najít.
- Identifikujte všechny testovací případy pro regiony/oblasti, kde chcete své řešení ověřit a nasadit. Testovací případy lze nalézt v základních testovacích případech integrátora.
- Před spuštěním testovacích případů je třeba spustit registrační transakce pro příslušná čísla testovacích účtů, která jsou k dispozici ve výchozím stavu testovacího případu.
- Poté spusťte všechny testovací případy pro regiony/oblasti, kde chcete své řešení ověřit a nasadit.
Krok 2: Vyplňte pracovní list PIW a krycí list pro ověření
Vyplňte všechny položky pracovního listu Product Information Worksheet (PIW) a krycího listu pro ověření integrátora s využitím příslušných kontaktních údajů a také informací o tom, jaké služby a možnosti plánujete nabízet.
Krok 3: Vytvoření a předání výstupů týmu ověření
Shromážděte následující výstupy, zkomprimujte je do souboru .zip a zašlete e-mailem na adresu validationmtp@fedex.com.. Doporučujeme vám odesílat soubory ve formátu .zip, abyste snížili riziko, že vaše odeslání bude zablokováno poskytovatelem e-mailové služby.
- Vyplněné pracovní listy PIW pro všechna uvedená území/regiony (formát: PDF)
- Vyplněný krycí list pro ověření (formát: PDF)
- Snímky obrazovky (formát: PDF):
- Vaše řešení pro zákazníky zobrazující služby FedEx/zvláštní zacházení
- Prohlášení o vyloučení odpovědnosti
- Licenční smlouva s koncovým uživatelem (EULA)
- Průběh registrace koncového zákazníka
- Transakce registrace koncových zákazníků – vícefaktorové ověřování včetně faktury a PINu dostupné pro SMS, hovory a e-mail (formát: soubory JSON request/response)
- Naskenované kopie skutečných vytištěných štítků pro všechny testovací případy zahrnuté v základním souboru testovacích případů pro území, kde má být vaše řešení ověřeno (formát: PDF nebo PNG)
- Transakce odeslání ze tří testovacích případů, jedna pro každý typ obrázku štítku: PDF, PNG a ZPL. (formát: soubory JSON request/response)
Abyste se vyhnuli zpoždění při zpracování, dodržujte tyto osvědčené postupy:
- Štítky musí být vytištěny a naskenovány v rozlišení alespoň 600 DPI.
- U termálních tiskáren musí být typ obrázku štítku vyžadován v souladu s modelem tiskárny. Příklad: Pro tiskárny Zebra se jedná o typ ZPLII
- Zásilky FedEx International Express® musí obsahovat také štítek pomocného/sekundárního leteckého nákladního listu (AWB).
- Vícekusé zásilky (MPS) musí obsahovat jeden štítek pro každý balík v zásilce.
Krok 4: Přezkoumejte hodnocení štítků
Tým pro ověření posoudí předložené výstupy a buď je schválí, nebo je odmítne. Tým pro ověření vás ohledně schválení nebo odmítnutí podání bude kontaktovat. Pokud jsou předložené výstupy schváleny, pokračujte k dalšímu kroku. Pokud jsou výstupy odmítnuty, opravte transakce, obrazovky nebo štítky podle pokynů a znovu je předložte ke schválení.
Krok 5: Povolte aplikaci
Poté, co jsou všechny výstupy během produkční fáze schváleny týmem pro ověření, tým autorizuje vaše produkční pověření k přenosu identifikované transakce přepravního štítku a prostřednictvím e-mailu vás informuje o úspěšném ověření. Vaše schválení se vztahuje vždy jen na konkrétní projekt.
Krok 6: Postupujte podle pokynů po ověření
Projděte si pokyny po ověření a podle potřeby je dodržujte.

