Nadawca FedEx
Wymaganie wstępne
Aby zalogować się do portalu FedEx Developer Portal i utworzyć organizację trzeba mieć identyfikator użytkownika FedEx.
Dołącz do organizacji w Twojej firmie, aby współpracować z zespołem. Jeśli Twoja firma nie ma organizacji, możesz ją utworzyć.
Dołączanie do istniejącej organizacji
1. Poproś o zaproszenie
Poproś administratora organizacji o przesłanie Ci zaproszenia. Należy je zaakceptować w ciągu 24 godzin. Jeśli zaproszenie utraci ważność, poproś administratora o ponowne przesłanie zaproszenia.
2. Zaakceptuj zaproszenie
Zaloguj się, podając identyfikator użytkownika i hasło. Jeśli Twój identyfikator użytkownika jest powiązany z inną organizacją, utwórz nowy.
Tworzenie nowej organizacji
Gdy tworzysz organizację, stajesz się jej administratorem. Jako administrator możesz zapraszać użytkowników do dołączenia do organizacji, przypisywać projekty i role oraz zarządzać kontami wysyłkowymi.
Aby dowiedzieć się więcej na temat ról użytkownika, zapoznaj się z Wytycznymi administrowania organizacją.
1. Zaloguj się na stronie FedEx Developer Portal.
2. Z poziomu menu wybierz opcję Moje projekty, a następnie wybierz pozycję Utwórz organizację.
3. Wprowadź następujące szczegóły:
- Dla opcji Pracuję dla firmy, która wybierz Korzysta z usług wysyłkowych FedEx i musi zintegrować interfejsy API FedEx z własnymi aplikacjami
- Wprowadź nazwę firmy, adres strony internetowej firmy i nazwę organizacji, którą rozpozna Twój zespół, np. nazwę firmy, dział, oddział lub region.
4. Wybierz opcję Utwórz.
Podane informacje możesz zaktualizować lub uzupełnić później, wybierając opcję Zarządzaj organizacją w menu.
Dodawanie konta wysyłkowego
1. Wybierz opcję Dodaj konta wysyłkowe na kafelku Dodaj konta. Jeśli nie masz konta FedEx, wybierz opcję Utwórz konto, aby założyć nowe, lub skontaktuj się z Biurem Obsługi Klienta FedEx.
2. Wybierz opcję + Dodaj konto.
3. Wprowadź numer konta FedEx, nazwę skrótową konta oraz adres rozliczeniowy użyty podczas konfiguracji konta.
4. Zaakceptuj umowę licencyjną użytkownika końcowego lub przekaż ją upoważnionemu przedstawicielowi swojej firmy.
Dodawanie konta rozliczeniowego
1. Wybierz kartę Konta rozliczeniowe. Jeśli nie masz konta rozliczeniowego FedEx, wybierz opcję Załóż konto rozliczeniowe , aby założyć nowe, lub skontaktuj się z Biurem Obsługi Klienta FedEx.
2. Wybierz opcję Dodaj konto rozliczeniowe. Konta rozliczeniowe muszą być zarejestrowane w Stanach Zjednoczonych.
3. Wprowadź numer konta FedEx, nazwę skrótową konta oraz adres rozliczeniowy w Stanach Zjednoczonych użyty podczas konfiguracji konta.
4. Przeczytaj i zaakceptuj umowę licencyjną użytkownika końcowego.
Zapraszanie użytkowników w roli administratora
1. Z poziomu menu wybierz opcję Zarządzaj organizacją, a następnie wybierz kartę Użytkownicy.
2. Wybierz opcję + Dodaj użytkowników.
3. Wybierz kraj lub terytorium oraz preferowany język, a następnie wybierz rolę użytkownika: przeglądający, współautor lub administrator.
4. (Opcjonalnie) Przypisz użytkownika do projektu. Użytkowników możesz przypisać w dowolnej chwili na stronie Przegląd projektu.
5. Wprowadź adresy e-mail użytkowników i kliknij opcję Zaproś. Za jednym razem możesz zaprosić do 20 użytkowników, rozdzielając każdy adres e-mail przecinkiem. Zaproszenia wygasną po 24 godzinach.
Tworzenie projektu API
1. Z poziomu menu wybierz opcję Moje projekty, a następnie wybierz kartę Interfejsy API i wybierz + Utwórz projekt API.
2. Potwierdź wymagania dotyczące interfejsu API.
3. Wybierz interfejsy API do dodania do projektu.
4. Nazwij projekt i wybierz kraje, do których planujesz wysyłkę, aby założyć testowe konto wysyłkowe. W przypadku przesyłek krajowych na terenie Europy dla każdego kraju musisz mieć osobne konto testowe. Kraje możesz dodać lub usunąć później.
5. Wybierz opcję Ustawienia w obszarze Powiadomienia, aby ustawić preferencje powiadomień.
6. Przeczytaj i zaakceptuj Warunki Przewozu.
Tworzenie projektu Advanced Integrated Visibility
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 widoczności przesyłki wymaga konta rozliczeniowego zarejestrowanego w Stanach Zjednoczonych oraz co najmniej jednego konta wysyłkowego. Te dwa rodzaje kont wzajemnie się wykluczają. Tylko administratorzy mogą dodawać konta rozliczeniowe i wysyłkowe na stronie Zarządzanie organizacją.
1. Utwórz docelowy adres URL w aplikacji lub na platformie, aby otrzymywać wywołania zwrotne. Adres URL:
- musi korzystać z protokołu HTTPS;
- nie może obejmować przestrzeni adresowej RFC1918, domeny fedex.com lub jej subdomen ani adresów IP takich jak localhost lub 127.0.0.1
2. Wygeneruj token zabezpieczeń do uwierzytelniania. Token musi:
- zawierać 26–100 znaków, co najmniej jedną wielką literę, co najmniej jedną małą literę oraz co najmniej jedną liczbę.
3. Z menu wybierz pozycję Moje projekty, a następnie wybierz kartę Advanced Integrated Visibility.
4. Wybierz opcję Utwórz projekt Advanced Integrated Visibility.
5. Wybierz typ użytkownika.
- Wysyłający FedEx: korzysta z usług wysyłkowych FedEx i musi zintegrować interfejsy API FedEx z własnymi aplikacjami.
- Dostawca FedEx Compatible: jest certyfikowanym dostawcą FedEx Compatible
- Dostawca FedEx Integrator: sprzedaje lub dostarcza oprogramowanie korzystające z technologii FedEx i jest zweryfikowanym dostawcą FedEx Integrator
6. Wybierz rodzaj subskrypcji. Możesz subskrybować zdarzenia według numerów kont lub numerów przesyłek.
7. Potwierdź konto rozliczeniowe i wybierz odpowiednie funkcje, np. potwierdzenie doręczenia, przewidywany termin doręczenia, monitorowane zdarzeń lub filtrowanie według zdarzeń.
8. Wprowadź szczegóły projektu.
- Wprowadź unikalną i rozpoznawalną nazwę projektu.
- Wprowadź docelowy adres URL i utworzony przez siebie token zabezpieczeń.
- Wprowadź adres e-mail i preferowany język, w którym będą wysyłane powiadomienia o aktualizacjach i awariach usługi Advanced Integrated Visibility.
9. Zaakceptuj umowę licencyjną FedEx Developer Portal oraz formularz zamówienia i wybierz opcję Utwórz.
Uwaga: W zależności od wybranego rodzaju subskrypcji mogą być wymagane dodatkowe kroki. Aby uzyskać więcej informacji, patrz dokumentacja dotycząca elementów webhook.
Wykonaj te kroki, aby zweryfikować integrację interfejsu API i potwierdzić, że aplikacja może wysyłać i odbierać dane testowe.
Pobieranie poświadczeń testowych
1. Z menu wybierz opcję Moje projekty, a następnie wybierz pozycję Nazwa projektu.
2. Na karcie Klucze API w obszarze Klucz testowy znajdź poświadczenia testowe.
3. Zaloguj się i pobierz kolekcję JSON API za pomocą przycisku Pobierz schematy JSON znajdującego się na górze strony dokumentacji. Przejrzyj przykładowe żądania dla punków końcowych używanych przez integrację.
4. Poproś o token dostępu OAuth, aby go używać przy każdej transakcji API.
Uwaga:Token jest ważny przez godzinę, więc możesz skonfigurować aplikację, aby ją odświeżyć przed wygaśnięciem. Aby uzyskać szczegółowe informacje, patrz dokumentacja dotycząca API Authorization.
5. Z menu wybierz Katalog interfejsów API, wybierz interfejs API, z którym chcesz pracować, a następnie wybierz pozycję Dokumentacja.
6. Z menu wybierz punkt końcowy.
7. Wyślij przykładowe żądania przy użyciu poświadczeń testowych oraz testowego adresu URL FedEx, a następnie potwierdź, że odpowiedzi są zgodne z przykładami w dokumentacji. Aby uzyskać szczegółowe informacje, zapoznaj się z Poradnikiem wirtualizacji piaskownicy.
8. Wykonaj testy przy użyciu Advanced Integrated Visibility, aby wygenerować przykładowe dane oraz potwierdzić, że procesy aplikacji prawidłowo monitorują informacje.
Uwaga: Testowanie nie uwierzytelnia adresu URL wywołania zwrotnego. Aby uzyskać szczegółowe informacje, patrz dokumentacja dotycząca Advanced Integrated Visibility.
Przeniesienie projektu do środowiska produkcyjnego
Przed uruchomieniem projektu skonfiguruj środowisko produkcyjne. Gdy projekt zostanie uruchomiony, możesz zmienić nazwę klucza, dodać więcej kont i sprawdzić numer konta wybrany podczas tworzenia projektu. Ten numer konta przenosi projekt do środowiska produkcyjnego.
Uwaga: Projekty Advanced Integrated Visibility oparte na numerze konta nie wymagają aktywacji środowiska produkcyjnego.
1. Z menu wybierz opcję Moje projekty, a następnie wybierz pozycję Nazwa projektu.
2. Wybierz kartę Klucz produkcyjny.
3. Pobierz poświadczenia produkcyjne i zapisz je w bezpiecznym miejscu.
- Skopiuj klucz produkcyjny interfejsu API i klucz tajny do bezpiecznej lokalizacji.
- Po zażądaniu klucza produkcyjnego zapisz go w bezpiecznej lokalizacji, ponieważ zostanie on wyświetlony tylko raz. Jeśli go utracisz, możesz później wygenerować nowy.
4. Wybierz przycisk Dalej, aby wyświetlić szczegóły projektu na karcie Klucz produkcyjny.
Aby dodać więcej kont wysyłkowych, wybierz opcję Edytuj w górnej części 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 , aby uzyskać pomoc.
Weryfikacja interfejsu API
Przed użyciem niektórych interfejsów API w środowisku produkcyjnym konieczna jest weryfikacja etykiet wysyłkowych. Zanim zaczniesz, zapoznaj się z wymaganiami dotyczącymi weryfikacji interfejsu API.
1. Z menu wybierz opcję Moje projekty, a następnie wybierz pozycję Nazwa projektu.
2. Na karcie Klucze API w obszarze Klucz testowy znajdź poświadczenia testowe.
3. Po zakończeniu testowania przenieś projekt do środowiska produkcyjnego w FedEx Developer Portal, aby rozpocząć weryfikację.
- Po zażądaniu klucza produkcyjnego zapisz go w bezpiecznej lokalizacji, ponieważ zostanie on wyświetlony tylko raz. Jeśli go utracisz, możesz później wygenerować nowy.
4. Podaj wymagane informacje na stronie tytułowej etykiety, w tym dane kontaktowe, usługi, które planujesz wdrożyć, numer konta i klucz produkcyjny interfejsu API.
5. Utwórz etykiety testowe w środowisku testowym FedEx, a następnie prześlij je grupie ds. analizy kodów kreskowych FedEx do weryfikacji. Ocena etykiet może potrwać do trzech dni roboczych.
Najlepsze praktyki, które pomogą uniknąć opóźnień:
- Drukuj i skanuj etykiety w rozdzielczości co najmniej 600 DPI. Nie przesyłaj plików wygenerowanych bezpośrednio z interfejsów API.
- W przypadku drukarek termicznych wybierz typ obrazu zgodny z modelem drukarki, na przykład ZPLII w przypadku drukarek Zebra.
- Używaj prawidłowych adresów wysyłającego i odbiorcy w przykładowych etykietach. Twórz etykiety wyłącznie do usług, z których planujesz korzystać.
- W przypadku usługi FedEx Collect on Delivery (COD) dodaj etykietę zwrotną COD.
- W przypadku przesyłek FedEx International Express® dołącz dodatkowy (pomocniczy) lotniczy list przewozowy (AWB).
- W przypadku przesyłek wieloelementowych (MPS) prześlij jedną etykietę dla każdej paczki.
Prześlij materiały przy użyciu jednej z następujących opcji:
- Prześlij plik PDF i stronę tytułową etykiety na adres e-mail label@fedex.com.
- Etykiety fizyczne prześlij pocztą tradycyjną na adres:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Uwaga: Upewnij się, że etykiety fizyczne nie mają widocznych defektów, np. śladów atramentu lub uszkodzeń. Nie powiększaj ani nie zmniejszaj drukowanych etykiet.
6. Grupa ds. analizy kodów kreskowych FedEx oceni przesłane etykiety i zatwierdzi je lub odrzuci. W przypadku ich odrzucenia odnieś się do informacji zwrotnych i prześlij je ponownie.
7. Po zatwierdzeniu grupa ds. analizy kodów kreskowych FedEx wyśle Ci wiadomość e-mail po autoryzacji poświadczeń produkcyjnych na potrzeby transakcji z użyciem etykiet wysyłkowych.
Uwaga: Zatwierdzenie obowiązuje dla jednego projektu. Każdy nowy projekt wymaga zatwierdzenia.
8. Zastąp testowe adresy URL oraz poświadczenia produkcyjnymi adresami URL oraz poświadczeniami.
9. Uruchom końcowy test produkcyjny z użyciem przykładowych danych, aby potwierdzić, że wszystko działa zgodnie z oczekiwaniami.
