1. Utwórz projekt, aby uzyskać poświadczenia
2. Zintegruj interfejsy API i przetestuj to wdrożenie
3. Przenieś projekt do środowiska produkcyjnego
4. Dokończ proces certyfikacji

Administrator lub współautor w organizacji może utworzyć projekt API, klikając przycisk Utwórz projekt API.

Zanim zaczniesz, musisz najpierw poinformować nas, dlaczego chcesz uzyskać dostęp do interfejsów API FedEx. Pojawi się okno modalne z listami rozwijanymi. Należy wybrać opcję, która najlepiej odpowiada Twoim potrzebom biznesowym w zakresie integracji z interfejsami API FedEx.

Jeśli jesteś nadawcą, możesz rozpocząć tworzenie projektu. Jest to proces trójetapowy:

Wybierz interfejsy API

Wybierz interfejsy API, które chcesz dodać do projektu. W zależności od wybranych interfejsów API może być konieczne dokonanie dodatkowych wyborów.

W przypadku wyboru interfejsu API śledzenia trzeba będzie również:

• Wybrać numer konta, który ma być powiązany z kluczem produkcyjnym.
• Zapoznać się z limitami interfejsu API śledzenia, limitami częstotliwości i szczegółami certyfikacji interfejsów API.
• Zdecydować, czy chcesz wyrazić zgodę na otrzymywanie wiadomości e-mail z powiadomieniami o przekroczeniu limitu transakcji.

Konfiguruj projekt

Wprowadź szczegóły projektu, w tym nazwę i lokalizację wysyłki.

• Nadaj projektowi rozpoznawalną nazwę, która nie powtarza się w 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, możesz ustawić preferencje dotyczące powiadomień.

Potwierdź szczegóły

Zapoznaj się ze szczegółami projektu, a następnie zaakceptuj warunki i postanowienia.

• Przeczytaj i zaakceptuj Umowę Licencyjną FedEx Developer Portal oraz potwierdź, że nie zamierzasz sprzedawać ani rozpowszechniać swojej aplikacji.
• Po kliknięciu przycisku „Utwórz” zostanie wyświetlony ekran potwierdzenia. Możesz teraz wyświetlić poświadczenia testowe dla nowego projektu.

• 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 można znaleźć w dokumentacji autoryzacji interfejsu API
• Kliknij wybrane dokumenty interfejsów API i zapoznaj się z kontekstem biznesowym każdego interfejsu API, aby dobrze zrozumieć, jak z niego korzystać. Możesz także przejrzeć przykładowe żądania dla punktu końcowego, który jest zgodny z żądaną integracją.
• Wdróż wywołania tych punktów końcowych zgodnie z opisem w przykładowych żądaniach, konfigurując je przy użyciu Twoich poświadczeń testowych.
• Upewnij się, że odebrane odpowiedzi na wywołania interfejsu API są zgodne z tymi podanymi w dokumentacji.
• Przetestuj swoje wdrożenie w środowisku testowym FedEx, używając swoich poświadczeń testowych i testowych adresów URL FedEx.

W ramach kroku Konfiguruj projekt:

• W razie potrzeby można 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.

W ramach kroku Pobierz klucze projektów:

• Zostanie wyświetlony klucz produkcyjny interfejsu API i produkcyjny klucz tajny. Koniecznie skopiuj je w bezpieczne miejsce.
• Ze względów bezpieczeństwa produkcyjny klucz tajny wyświetlamy tylko raz. Jeśli go zgubisz, możesz wygenerować nowy.
• Kliknij Dalej.

Nastąpi przekierowanie na stronę Przegląd projektu. W tym miejscu można dodać kolejne konta powiązane z projektem.

Na stronie Przegląd projektu:

• Kliknij 3 kropki ustawione pionowo (menu typu kebab), aby dodać kolejne konta powiązane z projektem.
• Następnie kliknij Edytuj.

Spowoduje to przekierowanie na stronę Klucz API, gdzie można dodać kolejne konta, które powinny być powiązane z kluczem produkcyjnym dla tego projektu.

1. Niektóre interfejsy API wymagają certyfikacji etykiet wysyłkowych, aby można było używać ich w środowisku produkcyjnym. Przeprowadź proces certyfikacji dla wszelkich wymagających tego interfejsów API w projekcie.

1. Po ukończeniu procesu certyfikacji i włączeniu wszystkich interfejsów API zaktualizuj żądania interfejsów API, zastępując testowe identyfikatory URI, klucze oraz konta wysyłkowe produkcyjnymi identyfikatorami URI, kluczami i kontem wysyłkowym.

2. Ponownie przetestuj wdrożenie w środowisku produkcyjnym, używając przykładowych danych.

3. Możesz już korzystać z tej nowej integracji!

Wymagania wstępne dotyczące tworzenia projektu elementu webhook

1. Utwórz prawidłowy adres URL w docelowej aplikacji/platformie
2. Wygeneruj token zabezpieczeń
3. Przetestuj adres URL elementu webhook
4. Zweryfikuj docelowy adres URL

Utwórz projekt elementu webhook

1. Utwórz projekt elementu webhook, aby otrzymywać skonfigurowane powiadomienia o ładunku

Wymagania wstępne dotyczące tworzenia projektu elementu webhook

Utwórz prawidłowy adres URL w docelowej aplikacji/platformie, aby otrzymywać kody uwierzytelniające/wiadomości i powiadomienia o ładunkach elementów Tracking webhook od firmy FedEx.

Wymogi dotyczące adresu URL:

Ten token zabezpieczeń można wykorzystywać jako klucz tajny do uwierzytelniania i weryfikowania informacji przesyłanych między Tobą (klientem) a firmą FedEx.

Wymagania dotyczące tokenów zabezpieczeń:

• minimalna długość: 25 znaków, maksymalna długość: 100 znaków
• 1 wielka litera
• 1 mała litera
• 1 cyfra

Testowanie adresu URL to krok opcjonalny, który może jednak okazać się przydatny.

Testowanie może pomóc w ustaleniu, czy adres URL utworzony w kroku 1 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.

Korzystając z metody algorytmu mieszającego HMAC SHA256, skonfiguruj proces uwierzytelniania w celu weryfikacji informacji przesyłanych między docelowym adresem URL a firmą FedEx.

1. Po kliknięciu Utwórz FedEx wygeneruje losowy ciąg wezwania, który jest przesyłany w treści żądania. Użytkownik powinien z kolei zwrócić ten ciąg wezwania do FedEx w treści żądania.

1. Zainicjuj kod uwierzytelniania wiadomości (MAC) przy użyciu algorytmu/procedury HMAC SHA256 w celu zmieszania (lub połączenia) ciągu wezwania z tokenem zabezpieczeń (lub kluczem tajnym), aby utworzyć podpis.

1. Prześlij do FedEx odpowiedź przy użyciu ciągu wezwania i odpowiedzi w postaci ciągu wezwania w treści żądania, wraz z kodem statusu HTTP 200 (OK) lub 202 (ACCEPTED (PRZYJĘTO)).

1. FedEx zweryfikuje następnie ciąg wezwania i odpowiedź w postaci ciągu wezwania.

• Po tym, jak FedEx otrzyma treść odpowiedzi, zweryfikuje ciąg wezwania i odpowiedź w postaci ciągu wezwania (lub wygenerowanego wcześniej podpisu), porównując je odpowiednio z ciągiem wezwania lub podpisem wygenerowanym przez FedEx.

• Jeśli ciąg wezwania i podpisy HMAC są zgodne, weryfikacja i przepływ pracy przebiegają pomyślnie. W przeciwnym razie proces weryfikacji nie powiedzie się i wyświetlony zostanie komunikat o błędzie.

Utwórz projekt elementu webhook

Na stronie Moje projekty wybierz kartę Elementy webhook.

Administrator lub współautor w organizacji może utworzyć projekt elementu webhook, klikając przycisk projektu Utwórz element webhook.

Zanim zaczniesz, musisz najpierw poinformować nas, dlaczego chcesz uzyskać dostęp do elementów webhook FedEx. Pojawi się okno modalne z listami rozwijanymi. Należy wybrać opcję, która najlepiej odpowiada Twoim potrzebom biznesowym w zakresie integracji z elementami webhook FedEx.

Jeśli uważasz się za nadawcę, możesz rozpocząć tworzenie projektu, wykonując następujące czynności:

1. Określ swoje potrzeby biznesowe

• Wybierz opcję, która najlepiej określa Twoje potrzeby biznesowe w zakresie integracji z elementami webhook FedEx.

1. Wybierz warstwę i funkcje warstwy

• Wybierz podstawową lub zaawansowaną warstwę elementu webhook dla swojego projektu zgodnie z jego wymogami.
• Wybór warstwy zawsze można zmienić.
• Każda warstwa jest objęta comiesięczną opłatą abonamentową.

• Wybierz funkcje, które chcesz skonfigurować w swoim projekcie.
• Funkcje można również edytować później.

1. Skonfiguruj szczegóły projektu

• Nadaj projektowi rozpoznawalną nazwę
• Wprowadź wstępnie wygenerowany docelowy adres URL i dane tokena zabezpieczeń utworzone na etapie uwierzytelniania wstępnego.

Wybierz konta

• Wybierz z listy uprawnione numery kont (w Stanach Zjednoczonych lub Kanadzie), które należy powiązać z projektem.

  5. Potwierdź szczegóły i zaakceptuj warunki

• Sprawdź szczegóły skonfigurowanego projektu.
• Przeczytaj i zaakceptuj Umowę Licencyjną Developer Portal (DPLA) oraz potwierdź, że nie zamierzasz rozpowszechniać swojej aplikacji.
• Przeczytaj i zaakceptuj Umowę cenową.
• Po kliknięciu przycisku Utwórz projekt:

1. Jeśli żądanie utworzenia zostało pomyślnie zweryfikowane i przetworzone, nastąpi przekierowanie do ekranu potwierdzenia.

• W przypadku nieudanej weryfikacji zostanie wyświetlony komunikat o błędzie.

1. Projekt elementu Tracking webhook będzie wówczas miał wygenerowany przez system identyfikator elementu webhook i status „Aktywny”.

1. FedEx tworzy organizację dostawcy Compatible.
2. Zaakceptuj zaproszenie.
3. Zaproś użytkowników do swojej organizacji.
4. Wybierz interfejsy API, których potrzebujesz do swojego rozwiązania.
5. FedEx tworzy projekty.
6. Zintegruj interfejsy API ze swoją aplikacją i uzyskaj certyfikat zgodności z programem Compatible.
7. FedEx przenosi projekty do środowiska produkcyjnego.
8. Wygeneruj produkcyjny klucz tajny.

• 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.
• Po ukończeniu certyfikacji i integracji możesz łatwo rozpowszechniać rozwiązanie wśród klientów.

• Aby uzyskać dostęp do artefaktów i dokumentacji integracji interfejsów API, zaakceptuj zaproszenie. Aby zaakceptować zaproszenie, musisz zalogować się przy użyciu swojego identyfikatora użytkownika FedEx i hasła lub utworzyć nowe, jeśli nie masz jeszcze poświadczeń.

• Jako administrator możesz zaprosić wszystkich członków zespołu, którzy potrzebują dostępu do projektu lub organizacji. Aby uzyskać szczegółowe informacje na temat różnych ról, zapoznaj się z przewodnikiem po administrowaniu organizacją.

• Jeśli Twoją organizację już utworzono, poproś jej administratora lub FedEx, aby zaprosił Cię do dołączenia do niej. Będziesz mieć 24 godziny na zaakceptowanie zaproszenia, ale jeśli przegapisz ten termin, możesz poprosić o ponowne wysłanie.

• Przejdź do Katalogu interfejsów API, aby wybrać odpowiednie interfejsy API 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.

• Wybierz interfejs API, aby zobaczyć jego omówienie, dzienniki zmian i kluczowe funkcje.

• Przejrzyj dokumentację interfejsu API, aby dowiedzieć się więcej na temat elementów żądań i odpowiedzi, poznać przykłady w wybranym języku programowania, obiekty błędów i uzyskać inne informacje.

• Wróć do portalu Salesforce, aby wypełnić arkusz informacji o produkcie (PIW, Product Information Worksheet) i wskazać interfejsy API, które chcesz dodać do swojego rozwiązania.

Po zatwierdzeniu arkusza PIW FedEx utworzy Twoje projekty. Każda wersja każdego z Twoich rozwiązań będzie mieć osobny projekt w FedEx Developer Portal. Jeśli użytkownik nie jest administratorem organizacji, musi otrzymać zaproszenie do przeglądania każdego projektu. 

Ponadto na tym etapie zespół FedEx Compatible wraz z zespołem FedEx CTC i zespołami ds. certyfikacji zorganizuje pokaz techniczny dotyczący interfejsów API we współpracy z Twoim zespołem. Zespół FedEx omówi nowe funkcje i możliwości dostępne w wersji interfejsów API, które wdrażasz. Zespół będzie w stanie odpowiedzieć na pytania techniczne dotyczące interfejsów API, testowania interfejsów API i wszystkich procesów, które należy ukończyć, aby rozpocząć proces „certyfikacji”* dla interfejsów API.

* Certyfikacja — proces zdefiniowany przez program FedEx Compatible w celu spełnienia wymagań zgodności z programem. Certyfikacja w programie Compatible jest wymagana, aby zapewnić, że wszyscy dostawcy Compatible wdrażają, promują i rozpowszechniają wśród nadawców (klientów) technologię FedEx zgodnie ze standardami technologii i usług FedEx.

1. Będziesz mieć teraz dostęp do testowego klucza API i testowego klucza tajnego, aby rozpocząć przeprowadzanie transakcji. Pobierz je z karty Test Key (Klucz testowy) na stronie Project Overview (Przegląd projektu).

1. Aby utworzyć klucze klienta, musisz użyć interfejsu API rejestracji poświadczeń, który jest prywatnym interfejsem API dostępnym tylko w sekcji interfejsów API danego projektu.
2. Po utworzeniu kilku kluczy klienta poproś o token dostępu OAuth, który będzie używany przy każdej transakcji interfejsu API. Sesja tokena jest ważna tylko przez godzinę, więc kod aplikacji musi odświeżać token przed wygaśnięciem sesji. Więcej informacji można znaleźć w dokumentacji autoryzacji interfejsu API. Przeglądając przykładowy kod, upewnij się, że z listy rozwijanej przykładów wybrano opcję „Reseller” (Sprzedawca).

1. Wybierz dokumenty dla interfejsów API na stronie Klucze testowe i przeczytaj kontekst biznesowy, aby dobrze zrozumieć, jak korzystać z wybranego interfejsu API. Przejrzyj przykładowe żądania dla punktu końcowego zgodne z żądaną integracją.
2. Wdróż wywołania tych punktów końcowych zgodnie z opisem w przykładowych żądaniach, konfigurując w nich używanie Twoich poświadczeń testowych.
3. Upewnij się,że odebrane odpowiedzi na wywołania interfejsu API są zgodne z tymi podanymi w dokumentacji.
4. W pełni przetestuj swoje wdrożenie w środowisku testowym FedEx, używając poświadczeń testowych i identyfikatorów URI FedEx.
5. Po pełnym przetestowaniu rozwiązań dokonaj certyfikacji każdego z nich w portalu Salesforce. FedEx w pełni sprawdzi wszystkie przesłane informacje i poinformuje Cię po zatwierdzeniu certyfikacji.

• Następnie FedEx przeniesie projekty do środowiska produkcyjnego.
• Wówczas produkcyjny klucz API będzie widoczny na karcie Production Key (Klucz produkcyjny) na stronie Project Overview (Przegląd projektu).

• Wygeneruj produkcyjny klucz tajny, klikając łącze Wygeneruj klucz tajny w kolumnie Klucz tajny.
• Możesz teraz ponownie przetestować wdrożenie w środowisku produkcyjnym, używając przykładowych danych.
• Możesz już korzystać z tej nowej integracji!