Wprowadzenie
FedEx Developer Portal oferuje zestaw interfejsów programowania aplikacji (API) umożliwiających integrację usług FedEx z Twoimi aplikacjami. Poniższe instrukcje pomogą Ci skonfigurować organizację, utworzyć projekt, przetestować integrację, przenieść projekt do środowiska produkcyjnego, a w niektórych przypadkach również zweryfikować interfejs API.
Typy użytkowników:
FedEx oferuje usługi integracji dla trzech typów użytkowników: wysyłających FedEx, zweryfikowanych dostawców oprogramowania zwanych dostawcami FedEx Compatible oraz zweryfikowanych dostawców FedEx Integrator.
Nadawca FedEx:
Firma korzystająca z usług wysyłkowych FedEx i potrzebująca integracji interfejsów API FedEx z własnym systemem.
Dostawca rozwiązań lub usług:
Firma potrzebująca integracji z interfejsami API FedEx w celu stworzenia rozwiązania, aplikacji lub wtyczki, która może zostać sprzedana i/lub przekazana zewnętrznej organizacji korzystającej z usług FedEx.
- Dostawca FedEx Compatible: zweryfikowana firma, która zawarła umowę w ramach programu FedEx Compatible.
- Dostawca FedEx Integrator: zweryfikowana firma, która zawarła umowę w ramach programu FedEx Integrator.
Spośród poniższych wybierz opcję, która najlepiej opisuje Twoją firmę. Niezależnie od typu użytkownika dostępna jest instrukcja wprowadzająca.
Wybierz, aby rozpocząć.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Wymaganie wstępne
Aby zalogować się do portalu FedEx Developer Portal i utworzyć organizację trzeba mieć identyfikator użytkownika FedEx.
Jeśli Twoja firma nie ma organizacji, utwórz ją. Możesz też dołączyć do istniejącej.
Utwórz nową organizację
Na pasku nawigacji kliknij Utwórz lub dołącz do organizacji.
Uwaga: po utworzeniu organizacji stajesz się automatycznie jej administratorem.
Administratorzy mogą:
Zapraszać użytkowników do dołączenia
Przypisywać użytkownikom role (np. współautora, przeglądającego) oraz projekty
Zarządzać kontami wysyłkowymi
Więcej informacji na temat tych ról znajduje się w Przewodniku administrowania organizacją.
Dla typu firmy wybierz „Sprzedaje lub dostarcza oprogramowanie korzystające z technologii FedEx i jest zweryfikowanym dostawcą FedEx Integrator”.
Podaj nazwę firmy, adres URL strony internetowej i unikalną nazwę organizacji. Nazwa organizacji może być taka sama jak nazwa firmy lub wskazywać określoną grupę (np. dział, oddział, region, lokalizację). Te informacje są niezbędne do zweryfikowania Twojego wniosku.
Uwaga: wybierz nazwę organizacji, która będzie rozpoznawalna dla wszystkich pozostałych użytkowników (np. nazwę firmy, działu, regionu, lokalizacji).
Określ lokalizację firmy oraz miejsce sprzedaży lub dystrybucji oprogramowania.
Dodaj konto rozliczeniowe i uwierzytelnij je.
Uwaga: jeśli jesteś dostawcą usług wysyłkowych i logistycznych w programie FedEx Integrator, musisz używać własnego numeru konta. Nie możesz używać konta FedEx klienta.
Wprowadź numer swojego konta FedEx. Jeśli nie masz konta FedEx, załóż je w witrynie fedex.com lub skontaktuj się z przedstawicielem Biura Obsługi Klienta FedEx.
Wprowadź nazwę skrótową konta i powiązany z kontem adres rozliczeniowy. Wybierz Dalej.
Uwaga: adres rozliczeniowy musi być zgodny z wpisami dotyczącymi tego konta. Będzie to domyślne konto rozliczeniowe Twojej organizacji.
Aby dokończyć tworzenie organizacji, musisz uwierzytelnić konto. Wybierz opcję uwierzytelnienia (e-mail lub wiadomość tekstowa, telefon wyłącznie w programie Integrator w USA i Kanadzie), następnie wybierz Dalej.
Po otrzymaniu kodu uwierzytelniającego wprowadź go i wybierz Prześlij.
Zaakceptuj warunki
Przeczytaj umowę globalnego integratora i instrukcję dotyczącą programu. Zaznacz pola, aby potwierdzić, że akceptujesz warunki, a następnie wybierz Akceptuj.
Zostanie wyświetlony ekran potwierdzenia. Kliknij Zarządzaj organizacją, aby w razie potrzeby edytować szczegóły
Zaproś użytkowników
Uwaga: użytkowników mogą zapraszać tylko administratorzy.
Na pasku nawigacji po lewej stronie wybierz Zarządzaj organizacją.
Przejdź do karty Użytkownicy i wybierz Dodaj użytkowników.
Wypełnij formularz i przypisz odpowiednie role do nowych użytkowników: Przeglądający, Współautor lub Administrator.
Więcej informacji na temat ról użytkowników znajduje się w Przewodniku administrowania organizacją.
Przypisz użytkowników do projektów (jeśli dotyczy) w rozwijanym menu w obszarze Projekty.
Wprowadź adresy e-mail poszczególnych użytkowników, a następnie wybierz Zaproś.
Dołącz do istniejącej organizacji
Poproś o zaproszenie: poproś administratora organizacji o przesłanie Ci zaproszenia. Musisz je zaakceptować w ciągu 24 godzin. W razie potrzeby poproś administratora o ponowne jego przesłanie.
Zaakceptuj zaproszenie: zaloguj się z użyciem aktualnego identyfikatora użytkownika i hasła. Jeśli identyfikator jest powiązany z inną organizacją, musisz utworzyć nowy.
Dołączanie do istniejącej organizacji
Krok 1. Poproś administratora organizacji, aby przesłał Ci zaproszenie.
Jeśli dla Twojej firmy utworzono już organizację, poproś administratora tej organizacji, aby zaprosił Cię do niej. Będziesz mieć 24 godziny na zaakceptowanie zaproszenia. Jeśli przegapisz ten termin, zawsze możesz poprosić o ponowne wysłanie.
Krok 2. Zaakceptuj zaproszenie.
Aby zaakceptować zaproszenie, musisz zalogować się przy użyciu istniejącego identyfikatora użytkownika i hasła lub utworzyć nowy identyfikator, jeśli istniejący jest już powiązany z organizacją.
Utwórz projekt API
Na stronie Moje projekty otwórz kartę Interfejsy API. Kliknij przycisk Utwórz projekt API.
Krok 1. Wybierz interfejsy API, które chcesz dodać do projektu
Zapoznaj się z limitami i ograniczeniami interfejsu API oraz szczegółami weryfikacji interfejsów API.
Krok 2. Skonfiguruj szczegóły projektu
- Nadaj projektowi rozpoznawalną nazwę, która nie powtarza się w obrębie organizacji.
- Wybierz kraje, w granicach których zamierzasz dokonywać wysyłek, abyśmy mogli przypisać Ci testowe konto wysyłkowe. Aby przetestować krajową wysyłkę paczek w kraju europejskim, musisz mieć osobne konto testowe dla każdego kraju. Kraje możesz dodawać/usuwać później.
- Aby otrzymywać powiadomienia o najnowszych aktualizacjach dotyczących interfejsów API i informacje o przerwach w działaniu, ustaw preferencje dotyczące powiadomień.
Krok 3. Przeczytaj ze zrozumieniem i zaakceptuj umowę licencyjną FedEx Developer Portal
Po zaakceptowaniu warunków i kliknięciu przycisku Utwórz zobaczysz ekran potwierdzenia. Możesz teraz wyświetlić poświadczenia testowe dla nowego projektu.
Utwórz projekt elementu webhook
Wymagane składniki
- Przejrzyj wycenę: subskrybenci są obciążani miesięczną opłatą zależną od liczby numerów przesyłek. Zapoznaj się z Przewodnikiem po wycenie, aby dowiedzieć się więcej o wycenie.
- Konfigurowanie kont: element webhook Advanced Integrated Visibility wymaga konta rozliczeniowego w Stanach Zjednoczonych oraz co najmniej jednego konta wysyłkowego. Te dwa typy kont są wzajemnie rozłączne. Tylko administratorzy mogą dodawać konta rozliczeniowe i wysyłkowe na stronie Zarządzanie organizacją.
Utwórz prawidłowy adres URL (wywołania zwrotnego) w docelowej aplikacji lub platformie
Twój docelowy adres URL będzie używany do odbierania kodów uwierzytelniających i wiadomości, a także powiadomień dotyczących ładunku elementów webhook od firmy FedEx. W celu zapewnienia bezpieczeństwa adres URL musi wykorzystywać protokół HTTPS. Zostaną zablokowane następujące adresy URL:
- Wszystkie w przestrzeni adresowej IP RFC1918.
- Zawierające domenę fedex.com lub dowolne z jej subdomen
- Adresy IP w adresie URL (w tym localhost, 127.0.0.1).
Generowanie tokenu zabezpieczeń
Ten token zabezpieczeń można wykorzystywać jako tajny klucz do uwierzytelniania i weryfikowania informacji przesyłanych między Twoją organizacją a firmą FedEx. Token zabezpieczeń musi zawierać:
- Minimum 26 znaków i maksymalnie 100 znaków
- 1 wielka litera
- 1 mała litera
- 1 cyfra
Przykład: Y1F6OiVUQW2JPSElmRE9U0IY5
Po zdefiniowaniu adresu URL i tokenu zabezpieczeń możesz przystąpić do tworzenia projektu elementu webhook. Na stronie Moje projekty otwórz kartę Elementy webhook. Kliknij przycisk Utwórz projekt elementu webhook.
Wybór typu subskrypcji
Nadawcy FedEx mogą przypisać zdarzenia do numerów kont lub numerów monitorowania.
Krok 1. Potwierdź konto rozliczeniowe i wybierz funkcje
- Sprawdź domyślne konto rozliczeniowe, aby je potwierdzić, lub wybierz inne konto należące do Twojej organizacji.
- Skonfiguruj projekt poprzez wybór funkcji, takich jak opcje potwierdzenia doręczenia, opcje spodziewanego terminu doręczenia, zdarzenia monitorowania czy filtrowanie oparte na zdarzeniach.
Krok 2. Wprowadź szczegóły dotyczące projektu
- Nadaj projektowi rozpoznawalną nazwę, która nie powtarza się w obrębie organizacji.
- Podaj docelowy adres URL i szczegóły tokenu zabezpieczeń utworzone podczas uwierzytelniania przed konfiguracją (patrz kroki powyżej).
- Aby otrzymywać powiadomienia o najnowszych aktualizacjach dotyczących elementów webhook oraz informacje o przerwach w działaniu, ustaw adres e-mail oraz preferowany język.
Krok 3. Przeczytaj i zaakceptuj warunki
Po zaakceptowaniu warunków, w tym umowy licencyjnej FedEx Developer Portal i formularza zamówienia, oraz kliknięciu przycisku Utwórz zobaczysz ekran potwierdzenia.
W zależności od wybranego typu subskrypcji mogą być wymagane dodatkowe kroki. Zajrzyj do dokumentacji, aby dowiedzieć się więcej.
Na stronie Przegląd projektu API pobierz poświadczenia testowe — klucz API, klucz tajny i konta wysyłkowe — z karty Klucz testowy.
Krok 1. Poproś o token dostępu OAuth
Poproś o token dostępu OAuth, który musi być używany z każdą transakcją API. Token jest ważny tylko przez godzinę, więc kod aplikacji musi odświeżać token przed wygaśnięciem sesji. Więcej informacji znajdziesz w dokumentacji autoryzacji interfejsu API.
Krok 2. Przejrzyj dokumentację interfejsów API
Kliknij dokumentację każdego z Twoich interfejsów API, aby zapoznać się z kontekstem biznesowym i zrozumieć, jak korzystać z danego interfejsu API. Zaloguj się, aby pobrać kolekcję JSON API za pomocą przycisku znajdującego się u góry strony dokumentacji. Możesz także przejrzeć przykładowe żądania dla punktu końcowego, który jest zgodny z żądaną integracją.
Krok 3. Użyj piaskownicy do przetestowania przykładowych transakcji
Kliknij żądany punkt końcowy w lewym panelu nawigacyjnym, aby przejść do konkretnej piaskownicy. Zidentyfikuj przykładowe żądania, które odpowiadają Twojemu przypadkowi zastosowania, a następnie użyj swoich poświadczeń testowych oraz testowych adresów URL FedEx do realizacji wywołań do punktu końcowego zgodnie z podanym opisem. Upewnij się, że odebrane odpowiedzi na wywołania interfejsu API są zgodne z tymi podanymi w dokumentacji. Więcej na temat testowania znajdziesz w poradniku wirtualizacji piaskownicy.
Testowanie z elementami webhook
Testowanie może pomóc w ustaleniu, czy utworzony adres URL jest prawidłowy. W ten sposób FedEx może zidentyfikować Twój adres URL i ustanowić z nim połączenie w celu przesłania danych. Testowanie może również zapewnić przykładowe dane testowe, które będą pomocne w sprawdzeniu i potwierdzeniu, czy jesteś w stanie przetwarzać dane monitorowania przekazane w aplikacji. Testowanie nie jest jednak równoznaczne z uwierzytelnieniem adresu URL. Aby dowiedzieć się, w jaki sposób przetestować swój adres URL elementu webhook, zapoznaj się z dokumentacją elementów webhook.
Na stronie Przegląd projektu otwórz kartę Klucz produkcyjny. Projekty związane z subskrypcją opartą na numerze konta funkcji Advanced Integrated Visibility nie muszą być przenoszone do środowiska produkcyjnego.
Krok 1. Skonfiguruj projekt
- W razie potrzeby możesz zmienić nazwę swojego klucza.
- Można sprawdzić numer konta wybrany w kroku 1 procesu tworzenia projektu. Używa się go do przenoszenia projektu do środowiska produkcyjnego. Gdy projekt znajduje się już w środowisku produkcyjnym, można w razie potrzeby dodawać kolejne konta.
Krok 2. Pobierz klucze projektu
Skopiuj klucz produkcyjny interfejsu API i tajny klucz produkcyjny w bezpieczne miejsce. Ze względów bezpieczeństwa tajny klucz produkcyjny wyświetlamy tylko raz. Jeśli go zgubisz, możesz wygenerować nowy.
Po uzyskaniu kluczy projektu i kliknięciu Dalej szczegóły projektu zostaną wyświetlone w karcie Klucz produkcyjny.
- Aby dodać więcej kont wysyłkowych do projektu, kliknij opcję Edytuj u góry tabeli kont wysyłkowych.
Kroki weryfikacji różnią się w różnych regionach
Następujące kroki dotyczą tylko klientów w Stanach Zjednoczonych i Kanadzie. Jeśli mieszkasz w innym kraju, odwiedź stronę Weryfikacja interfejsu API w celu uzyskania wsparcia.
Niektóre interfejsy API wymagają weryfikacji etykiet wysyłkowych, aby można było używać ich w środowisku produkcyjnym. Sprawdź, czy Twój interfejs API wymaga weryfikacji.
Krok 1. Opracuj aplikację internetową i przetestuj ją z interfejsami API FedEx
Po opracowywaniu aplikacji internetowej sfinalizuj testowanie przy użyciu poświadczeń testowych (testowych kont wysyłkowych, klucza API i klucza tajnego). Testowy klucz API i klucz tajny zostaną wyświetlone na stronie Przegląd projektu i będą dostępne w dowolnym momencie.
Krok 2. Przenieś projekt do środowiska produkcyjnego
Po przetestowaniu z interfejsami API FedEx musisz rozpocząć proces weryfikacji, przenosząc projekt do środowiska produkcyjnego w portalu FedEx Developer Portal. Po pomyślnym zakończeniu tego procesu zostaną wyświetlone produkcyjny klucz API i klucz tajny. Produkcyjny klucz tajny zostanie wyświetlony tylko raz, ale będziesz w stanie wygenerować go ponownie później.
Krok 3. Wypełnij stronę tytułową etykiety
Wypełnij wszystkie pola na stronie tytułowej etykiety, podając odpowiednie dane kontaktowe oraz usługi, które planujesz wdrożyć. Podaj numer konta i klucz produkcyjny.
Krok 4. Wygeneruj i prześlij etykiety testowe do grupy ds. analizy kodów kreskowych
Wygeneruj etykiety testowe w środowisku testowym FedEx powiązanym z aplikacją, a następnie prześlij etykiety testowe do zespołów ds. oceny etykiet FedEx w celu zatwierdzenia. Grupa ds. analizy kodów kreskowych potrzebuje trzech dni roboczych na ocenę etykiety.
Aby uniknąć opóźnień w przetwarzaniu, przestrzegaj następujących dobrych praktyk:
- Etykiety muszą być drukowane i skanowane w rozdzielczości co najmniej 600 DPI. NIE WYSYŁAJ PLIKÓW WYGENEROWANYCH PRZEZ INTERFEJS API.
- W przypadku drukarek termicznych typ obrazu etykiety należy zamówić zgodnie z modelem drukarki. Przykład: ZPLII w przypadku drukarek Zebra.
- Podczas tworzenia przykładowych etykiet do oceny użyj informacji o adresie nadawcy/odbiorcy. Twórz przykładowe etykiety tylko dla konkretnych usług, do których będą stosowane.
- Etykieta płatności przy odbiorze FedEx® musi zawierać też odpowiednią etykietę zwrotną płatności przy odbiorze.
- Przesyłki FedEx International Express® muszą zawierać też dodatkową/pomocniczą etykietę lotniczego listu przewozowego.
- Przesyłki wieloczęściowe (MPS) muszą zawierać po jednej etykiecie dla każdej paczki w przesyłce.
- Wyślij plik PDF i stronę tytułową etykiety na adres: label@fedex.com.
- Etykiety fizyczne można wysyłać na poniższy adres:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017, USA
Jeśli zeskanowane etykiety nie mają widocznych defektów (takich jak linie przechodzące przez kod kreskowy, plamy tuszu czy uszkodzenia fizyczne), przejdą kontrolę i uzyskają zatwierdzenie.
Wysyłając etykiety fizyczne, zwróć uwagę na jakość wydruku i przypadkowe powiększenie/skurczenie etykiet (tj. skalowanie). Są to dwa główne powody, dla których etykiety nie przechodzą pomyślnie procesu oceny.
Krok 5. Sprawdź ocenę etykiety
Grupa ds. analizy kodów kreskowych oceni przesłane etykiety testowe i zatwierdzi je lub odrzuci. Grupa ds. analizy kodów kreskowych skontaktuje się z Tobą w sprawie zatwierdzenia lub odrzucenia przesłanych etykiet. Jeśli etykiety zostały zatwierdzone, przejdź do następnego kroku. Jeśli etykiety zostały odrzucone, popraw je zgodnie z instrukcją i prześlij ponownie do zatwierdzenia.
Krok 6. Włącz aplikację
Po zatwierdzeniu etykiet testowych do statusu produkcyjnego grupa ds. analizy kodów kreskowych autoryzuje Twoje poświadczenia produkcyjne do przesyłania zidentyfikowanej transakcji etykiet wysyłkowych i powiadomi Cię za pomocą wiadomości e-mail o pomyślnej weryfikacji. Zatwierdzenia są udzielane dla poszczególnych projektów.
Krok 7. Zamień adres URL i poświadczenia
Zamień testowy adres URL i poświadczenia testowe na produkcyjny adres URL i poświadczenia produkcyjne. Ponownie przetestuj wdrożenie w środowisku produkcyjnym, używając przykładowych danych.
Wymaganie wstępne
Twoja firma musi być istniejącym dostawcą FedEx Compatible. Jeśli Twoja firma nie uczestniczy w programie Compatible, zmień powyższy wybór na „Dostawca spoza programu Compatible”.
Krok 1. Odbierz zaproszenie do dołączenia do organizacji
FedEx utworzy organizację, a następnie zaprosi jednego członka zespołu do dołączenia do niej. Ten użytkownik zostanie wyznaczony jako administrator w tej organizacji.
Krok 2. Zaakceptuj zaproszenie
Aby zaakceptować zaproszenie, musisz zalogować się przy użyciu istniejącego identyfikatora użytkownika i hasła lub utworzyć nowy identyfikator, jeśli istniejący jest już powiązany z organizacją.
Krok 3. Zaproś użytkowników
Administrator może zapraszać użytkowników do organizacji oraz przypisywać im role i projekty. Otwórz zakładkę Użytkownicy. Kliknij przycisk Dodaj użytkowników.
- Wybierz rolę użytkownika: przeglądający, współautor lub administrator. Więcej o tych rolach znajdziesz w wytycznych administrowania organizacją.
- Jeśli już masz utworzone projekty, przypisz projekt do użytkownika. Użytkowników możesz również przypisywać do projektów z poziomu dowolnej strony Przegląd projektu.
- Wprowadź adresy e-mail użytkowników, których chcesz dodać do swojej organizacji w ramach wybranej roli.
Przejdź do Katalogu interfejsów API, aby wybrać odpowiednie interfejsy API lub elementy webhook dla swojego rozwiązania. Twój doradca klienta ds. technologii FedEx (CTC) i kierownik ds. kanału Compatible mogą pomóc w wyborze odpowiednich interfejsów API dla rozwiązania zgodnie z potrzebami biznesowymi.
Krok 1. Wypełnij arkusz PIW
Wróć do społeczności dostawców FedEx Compatible (CPC), aby wypełnić arkusz informacji o produkcie (PIW).
Krok 2. Przejrzyj projekty utworzone przez FedEx
Po zatwierdzeniu arkusza PIW FedEx utworzy Twoje projekty. Każda wersja każdego z Twoich rozwiązań będzie mieć osobny projekt w ramach FedEx Developer Portal.
Krok 3. Weź udział w pokazie technicznym interfejsu API wraz ze swoim zespołem
Zespół FedEx Compatible wraz z zespołem FedEx CTC i zespołami ds. weryfikacji zorganizuje pokaz techniczny dotyczący interfejsów API we współpracy z Twoim zespołem. Zespół FedEx omówi procedurę weryfikacji programu FedEx Compatible, nowe funkcje i możliwości interfejsu API oraz odpowie na pytania.
Na stronie Przegląd projektu API pobierz poświadczenia testowe — klucz API i klucz tajny — z karty Klucz testowy.
Krok 1. Utwórz klucze klienta
Użyj interfejsu API rejestracji poświadczeń do utworzenia kluczy klienta. Jest to prywatny interfejs API, który można znaleźć wyłącznie w sekcji API na dole strony Przegląd projektu API.
Krok 2. Poproś o token dostępu OAuth
Poproś o token dostępu OAuth, który musi być używany z każdą transakcją API. Token jest ważny tylko przez godzinę, więc kod aplikacji musi odświeżać token przed wygaśnięciem sesji. Więcej informacji znajdziesz w dokumentacji autoryzacji interfejsu API. Przeglądając przykładowy kod, upewnij się, że z listy rozwijanej przykładów wybrano opcję „Reseller” (Sprzedawca).
Krok 3. Przejrzyj dokumentację interfejsu API
Kliknij dokumentację każdego z Twoich interfejsów API, aby zapoznać się z kontekstem biznesowym i zrozumieć, jak korzystać z danego interfejsu API. Zaloguj się, aby pobrać kolekcję JSON API za pomocą przycisku znajdującego się u góry strony dokumentacji. Możesz także przejrzeć przykładowe żądania dla punktu końcowego, który jest zgodny z żądaną integracją.
Krok 4. Użyj piaskownicy do przetestowania przykładowych transakcji
Kliknij żądany punkt końcowy w lewym panelu nawigacyjnym, aby przejść do konkretnej piaskownicy. Zidentyfikuj przykładowe żądania, które odpowiadają Twojemu przypadkowi zastosowania, a następnie użyj swoich poświadczeń testowych oraz testowych adresów URL FedEx do realizacji wywołań do punktu końcowego zgodnie z podanym opisem. Upewnij się, że odebrane odpowiedzi na wywołania interfejsu API są zgodne z tymi podanymi w dokumentacji. Więcej na temat testowania znajdziesz w poradniku wirtualizacji piaskownicy.
Krok 5. Sprawdź każde rozwiązanie
Po pełnym przetestowaniu rozwiązań prześlij przypadki testowe do zespołu ds. weryfikacji. FedEx w pełni sprawdzi wszystkie przesłane dane i poinformuje Cię o wyniku weryfikacji.
Testowanie z elementami webhook
Jeśli Twoja organizacja ma dostęp do elementów webhook, testowanie może pomóc w ustaleniu, czy utworzony adres URL jest prawidłowy. W ten sposób FedEx może zidentyfikować Twój adres URL i ustanowić z nim połączenie w celu przesłania danych. Testowanie może również zapewnić przykładowe dane testowe, które będą pomocne w sprawdzeniu i potwierdzeniu, czy jesteś w stanie przetwarzać dane monitorowania przekazane w aplikacji. Testowanie nie jest jednak równoznaczne z uwierzytelnieniem adresu URL. Aby dowiedzieć się, w jaki sposób przetestować swój adres URL elementu webhook, zapoznaj się z dokumentacją elementów webhook.
Następnie FedEx przeniesie projekty do środowiska produkcyjnego. Na stronie Przegląd projektu API otwórz kartę Klucz produkcyjny. Kliknij link Generuj klucz tajny w kolumnie Klucz tajny.
Możesz teraz ponownie przetestować wdrożenie w środowisku produkcyjnym, używając przykładowych danych.
Wymaganie wstępne
Aby zalogować się do portalu FedEx Developer Portal i utworzyć organizację trzeba mieć identyfikator użytkownika i konto FedEx.
Utwórz organizację, jeśli Twoja firma jej jeszcze nie ma, lub dołącz do istniejącej organizacji.
Tworzenie nowej organizacji
Na pasku nawigacji kliknij Utwórz lub dołącz do organizacji.
Uwaga: po utworzeniu organizacji stajesz się automatycznie jej administratorem.
Administratorzy mogą:
Zapraszać użytkowników do dołączenia
Przypisywać użytkownikom role (np. współautora, przeglądającego) oraz projekty
Zarządzać kontami wysyłkowymi
Więcej informacji na temat tych ról znajduje się w Przewodniku administrowania organizacją.
Dla typu firmy wybierz „Sprzedaje lub dostarcza oprogramowanie korzystające z technologii FedEx i jest zweryfikowanym dostawcą FedEx Integrator”.
Podaj nazwę firmy, adres URL strony internetowej i unikalną nazwę organizacji. Nazwa organizacji może być taka sama jak nazwa firmy lub wskazywać określoną grupę (np. dział, oddział, region, lokalizację). Te informacje są niezbędne do zweryfikowania Twojego wniosku.
Uwaga: Wybierz nazwę organizacji, która będzie rozpoznawalna dla wszystkich pozostałych użytkowników (np. nazwę firmy, działu, regionu, lokalizacji).
Określ lokalizację firmy oraz miejsce sprzedaży lub dystrybucji oprogramowania.
Dodaj konto rozliczeniowe i uwierzytelnij je.
Uwaga: Jeśli jesteś dostawcą usług wysyłkowych i logistycznych w programie FedEx Integrator, musisz używać własnego numeru konta. Nie możesz używać konta FedEx klienta.
Wprowadź numer swojego konta FedEx. Jeśli nie masz konta FedEx, załóż je w witrynie fedex.com lub skontaktuj się z przedstawicielem Biura Obsługi Klienta FedEx.
Wprowadź nazwę skrótową konta i powiązany z kontem adres rozliczeniowy. Wybierz Dalej.
Uwaga: Adres rozliczeniowy musi być zgodny z wpisami dotyczącymi tego konta. Będzie to domyślne konto rozliczeniowe Twojej organizacji.
Aby dokończyć tworzenie organizacji, musisz uwierzytelnić konto. Wybierz opcję uwierzytelnienia (e-mail lub wiadomość tekstowa, telefon wyłącznie w programie Integrator w USA i Kanadzie), następnie wybierz Dalej.
Po otrzymaniu kodu uwierzytelniającego wprowadź go i wybierz Prześlij.
Zaakceptuj warunki
Przeczytaj umowę integratora FedEx i instrukcję dotyczącą programu. Zaznacz pola, aby potwierdzić, że akceptujesz warunki, a następnie wybierz Akceptuj.
Zostanie wyświetlony ekran potwierdzenia. Kliknij Zarządzaj organizacją, aby w razie potrzeby edytować szczegóły
Zaproś użytkowników
Uwaga: Użytkowników mogą zapraszać tylko administratorzy.
Na pasku nawigacji po lewej stronie wybierz Zarządzaj organizacją.
Przejdź do karty Użytkownicy i wybierz Dodaj użytkowników.
Wypełnij formularz i przypisz odpowiednie role do nowych użytkowników: Przeglądający, Współautor lub Administrator.
Więcej informacji na temat ról użytkowników znajduje się w Przewodniku administrowania organizacją.
Przypisz użytkowników do projektów (jeśli dotyczy) w rozwijanym menu w obszarze Projekty.
Wprowadź adresy e-mail poszczególnych użytkowników, a następnie wybierz Zaproś.
Dołącz do istniejącej organizacji
Poproś o zaproszenie: poproś administratora organizacji o przesłanie Ci zaproszenia. Musisz je zaakceptować w ciągu 24 godzin. W razie potrzeby poproś administratora o ponowne jego przesłanie.
Zaakceptuj zaproszenie: zaloguj się z użyciem aktualnego identyfikatora użytkownika i hasła. Jeśli identyfikator jest powiązany z inną organizacją, musisz utworzyć nowy.
Utwórz projekt API
Przejdź na stronę Moje projekty i wybierz Utwórz projekt.
Wypełnij pole Nazwa projektu. Zalecamy nazwę w formacie „Nazwaprojektu_nazwaaplikacji”. Po wpisaniu nazwy wybierz Dalej.
Do projektu wybierz API i produkty Advanced Integrated Visibility.
Uwaga: Produkty Advanced Integrated Visibility są dostępne wyłącznie dla dostawców FedEx Integrator w USA.
Uwaga: Jeśli wybierzesz produkty płatne, zostanie wyświetlony monit o przypisanie do projektu konta rozliczeniowego i zaakceptowanie wymaganych warunków.
Przypisz konto rozliczeniowe i zaakceptuj warunki
Przypisz konto rozliczeniowe z listy kont dodanych do organizacji. To działanie jest konieczne tylko, jeśli wcześniej został wybrany produkt płatny.
Zaakceptuj warunki powiązane z produktem.
Potwierdź szczegóły
Sprawdź wybrane produkty. Zweryfikuj podane konto rozliczeniowe.
Sprawdź i zaakceptuj umowę licencyjną FedEx Developer Portal.
Kliknij Utwórz, aby wygenerować projekt i wyświetlić poświadczenia testowe.
Skonfiguruj funkcję Advanced Integrated Visibility w projekcie
Wymagane składniki
Wymagane składniki
- Przejrzyj cennik: subskrybenci są obciążani miesięczną opłatą zależną od liczby numerów przesyłek. Zapoznaj się z formularzem zamówienia, aby dowiedzieć się więcej o cenach.
- Konfigurowanie kont: Advanced Integrated Visibility wymaga konta rozliczeniowego w Stanach Zjednoczonych oraz co najmniej jednego konta wysyłkowego. Te dwa typy kont są wzajemnie rozłączne. Tylko administratorzy mogą dodawać konta rozliczeniowe i wysyłkowe na stronie Zarządzanie organizacją.
Utwórz prawidłowy adres URL wywołania w aplikacji lub na platformie docelowej — Twoja aplikacja/adres URL platformy:
Musi wykorzystywać protokół HTTPS celu zapewnienia bezpieczeństwa.
Nie może obejmować przestrzeni adresowej RFC1918 IP, subdomen fedex.com ani bezpośrednich adresów IP (np. 127.0.0.1).
Wygeneruj token zabezpieczeń
Musi zawierać od 26–100 znaków oraz:
- 1 wielką literę
- 1 małą literę
- 1 cyfrę
Przykład: Y1F6OiVUQW2JPSElmRE9U0IY5
Skonfiguruj funkcję Advanced Integrated Visibility
Wybierz Advanced Integrated Visibility. Wybierz takie funkcje jak potwierdzenie doręczenia, przewidywany termin doręczenia, monitorowanie zdarzeń i filtrowanie oparte na zdarzeniach.
Wprowadź docelowy adres URL i token zabezpieczeń.
Podaj adres e-mail do aktualizacji Advanced Integrated Visibility oraz powiadomień o przestojach.
Potwierdź szczegóły
Przeczytaj i zaakceptuj umowę licencyjną FedEx Developer Portal i formularz zamówienia.
Wybierz Utwórz, aby ukończyć konfigurację.
Uwaga: W zależności od typu subskrypcji mogą być wymagane dodatkowe działania. Więcej szczegółów można znaleźć w dokumentacji.
Pobierz poświadczenia testowe i zacznij testować
Przejrzyj dokumentację interfejsu API
- Przeczytaj dokumentację interfejsu API, aby zrozumieć różne oferowane przez nas interfejsy API oraz kontekst biznesowy i procesy integracji.
- Pobierz Schematy JSON ze strony dokumentacji odpowiedniego interfejsu API.
- Przejrzyj przykładowe żądania dla wybranych punktów końcowych.
Pobierz poświadczenia testowe
Na stronie Przegląd projektu przejdź na kartę Klucze API. Klucz API i klucz tajny znajdują się pod nagłówkiem Klucz testowy.
Przejrzyj dokumentację interfejsu API
- Token OAuth jest wymagany w przypadku wszystkich transakcji API i wygaśnie po godzinie.
- Aplikacja musi odświeżyć token przed jego wygaśnięciem.
- Szczegóły można znaleźć w dokumentacji dotyczącej autoryzacji interfejsu API.
Testuj transakcje API w piaskownicy
- Przejdź do odpowiedniego interfejsu API w karcie Katalog API i wybierz Dokumentacja.
- W menu po lewej stronie wybierz odpowiedni punkt końcowy API.
- Użyj przykładowych żądań, które odpowiadają przypadkowi użycia.
- Wdrażaj wywołania API przy użyciu poświadczeń testowych i testowych adresów URL FedEx.
- Sprawdź odpowiedzi w dokumentacji.
- Więcej szczegółów można znaleźć w Przewodniku po wirtualizacji piaskownicy.
Testowanie usługi Advanced Integrated Visibility
Testowanie usługi Advanced Integrated Visibility pozwala zweryfikować format adresu URL i pomaga nawiązać połączenie między FedEx a Twoją aplikacją.
Test obejmuje przykładowe dane testowe do przetwarzania danych monitorowania.
Uwaga: Testowanie nie uwierzytelnia adresu URL.
Aby dowiedzieć się więcej, zapoznaj się z dokumentacją dotyczącą usługi Advanced Integrated Visibility.
Do przeniesienia interfejsów API do środowiska produkcyjnego wymagana jest weryfikacja. Poziom weryfikacji może się różnić dla poszczególnych interfejsów API.
Twórz i testuj interfejsy API FedEx
- Użyj poświadczeń testowych (klucza API i klucza tajnego) ze strony Przegląd projektu.
- Zidentyfikuj przypadki testowe dla regionów/terytoriów, gdzie planujesz wdrożyć swoje rozwiązanie (zapoznaj się z dokumentacją bazową przypadków testowych integratora).
- Przed uruchomieniem przypadków testowych ukończ transakcje rejestracyjne przy użyciu podanych numerów konta testowego.
- Wykonaj wszystkie wymagane przypadki testowe.
Przejdź na stronę Przegląd projektu.
Wybierz Poproś o klucze produkcyjne. FedEx odbierze Twoją prośbę o klucze produkcyjne i gdy tylko zostaną zatwierdzone, otrzymasz powiadomienie.
Wypełnij arkusz PIW i formularz weryfikacji
Wypełnij arkusz informacji o produkcie (PIW) i formularz weryfikacji integratora. Podaj dane kontaktowe oraz planowane usługi FedEx.
Prześlij materiały
Zbierz i skompresuj następujące pliki do pliku .zip, aby uniknąć ograniczeń dostawcy poczty elektronicznej. Wyślij wiadomość na adres validationmtp@fedex.com.
Wymagane materiały
- Wypełniony arkusz PIW (PDF).
- Wypełniony formularz weryfikacji (PDF).
Zrzuty ekranu (PDF):
Rozwiązanie skierowane do klientów, prezentujące usługi FedEx/obsługę specjalną
Oświadczenie o wyłączeniu odpowiedzialności
Umowa licencyjna użytkownika końcowego
Przepływ rejestracji klienta końcowego
- Transakcje rejestracji klienta końcowego z uwierzytelnianiem wieloskładnikowym (JSON)
- Zeskanowane etykiety wysyłkowe dla wszystkich odpowiednich przypadków testowych (PDF/PNG)
- Transakcje wysyłkowe dla trzech formatów etykiet: PDF, PNG oraz ZPL (JSON) (dla odpowiednich interfejsów API wysyłki i oceny)
Najlepsze praktyki mające na celu uniknięcie opóźnień
- Etykiety należy drukować i skanować w rozdzielczości co najmniej 600 DPI .
- Etykiety do drukarek termicznych muszą być zgodne z modelem drukarki (np., ZPLII w przypadku drukarek Zebra).
- Przesyłki FedEx International Express® muszą mieć pomocnicza etykietę lotniczego listu przewozowego.
- Przesyłki wieloelementowe (MPS) muszą mieć etykietę w przypadku każdej paczki.
Ocena etykiet
Grupa ds. weryfikacji zatwierdzi lub odrzuci przesłane materiały.
- W przypadku odrzucenia wprowadź poprawki i prześlij ponownie w zależności od opinii.
- W przypadku zatwierdzenia otrzymasz e-mail potwierdzający weryfikację. Po otrzymaniu e-maila nastąpi autoryzacja poświadczeń produkcyjnych na potrzeby transakcji z udziałem etykiet wysyłkowych.
Postępuj zgodnie z instrukcjami poweryfikacyjnymi
W razie potrzeby sprawdzaj i wdrażaj wymagania poweryfikacyjne.
Po otrzymaniu powiadomienia z informacją, że klucze produkcyjne zostały zatwierdzone, pobierz je z karty Przegląd projektu.
- Skopiuj i bezpiecznie przechowuj produkcyjny klucz API i klucz tajny.
- Klucz tajny jest wyświetlany tylko raz — w przypadku jego utraty należy wygenerować nowy.
