Wprowadzenie

Rozpocznij integrację jako dostawca FedEx Compatible, wykorzystując możliwości interfejsów API FedEx. Poniższe instrukcje poprowadzą Cię przez poszczególne etapy procesu rozszerzania funkcji i możliwości FedEx w Twoim rozwiązaniu.


Krok 1:

Przeglądaj interfejsy API, aby określić, czego potrzebujesz dla swojej aplikacji.

  • Przejdź do katalogu interfejsu API, aby wybrać odpowiednie interfejsy API dla swojej aplikacji.
  • Wybierz interfejs API, aby zobaczyć jego omówienie, dziennik zmian i kluczowe funkcje.
Zrzut ekranowy strony „Stawka — przegląd”
  • Przejrzyj dokumentację interfejsu API, aby dowiedzieć się więcej na temat elementów żądań i odpowiedzi, poznać przykłady w wybranym języku programowania, przejrzeć kody błędów i uzyskać inne informacje.
Zrzut ekranowy strony „Stawka — dokumentacja”
  • Zajrzyj do ogłoszeń, aby dowiedzieć się więcej o planowanych aktualizacjach usług i sprawdzić, co nowego.

Krok 2:

Zarejestruj się lub zaloguj, aby rozpocząć integrację z interfejsami API FedEx.

  • Zaloguj się za pomocą identyfikatora użytkownika i hasła używanymi z witryną fedex.com, aby rozpocząć integrację z interfejsami API FedEx.
  • Jeśli nie masz jeszcze identyfikatora użytkownika, zarejestruj się bezpłatnie.

Krok 3:

Utwórz organizację lub dołącz do niej.

Utwórz organizację, jeśli Twoja firma jej jeszcze nie ma, lub dołącz do istniejącej organizacji. Z organizacją można skojarzyć wielu użytkowników, ale nie można skojarzyć wielu organizacji z jednym identyfikatorem użytkownika.

Jeśli utworzysz organizację, automatycznie zostaniesz jej administratorem. Administrator może zapraszać użytkowników do dołączenia do organizacji, przypisywać im role i projekty oraz zarządzać kontami wysyłkowymi. Aby dowiedzieć się więcej o tym, które role najlepiej nadają się dla poszczególnych użytkowników, zapoznaj się z wytycznymi dotyczącymi administrowania organizacją. Aby utworzyć własną organizację, kliknij pozycję Moje projekty, a następnie kliknij przycisk „Utwórz organizację”. Ten przycisk będzie wyświetlany tylko wtedy, gdy używany identyfikator użytkownika nie został jeszcze powiązany z istniejącą organizacją. Na tym etapie możesz rozpocząć tworzenie organizacji, wykonując następujące czynności (kroki oznaczone gwiazdką * są opcjonalne):

  • Wpisz nazwę organizacji.
  • Wpisz adresy e-mail wszystkich członków zespołu, których chcesz zaprosić. Zostaną automatycznie dodani jako przeglądający i nie będą skojarzeni z żadnymi projektami*.
Zrzut ekranowy strony „Utwórz organizację”

Możesz także dołączyć do organizacji swojej firmy, wykonując następujące czynności:

  • Jeśli dla Twojej firmy utworzono już organizację, poproś administratora tej organizacji, 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.
  • 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 4:

Dodaj konto wysyłkowe.

Administrator może dodać tyle kont wysyłkowych, ile potrzeba w ramach organizacji. Aby rozpocząć, kliknij przycisk „Dodaj konto” na karcie Konta wysyłkowe na stronie Zarządzaj organizacją. Następnie możesz dodać do organizacji istniejące konto wysyłkowe, wykonując następujące czynności:

  1. Uzupełnij informacje o koncie
  • Wprowadź numer konta, ewentualną nazwę skrótową konta i adres rozliczeniowy powiązany z kontem. Te informacje zostaną zweryfikowane, aby upewnić się, że są zgodne z danymi konta, w celu zapobieżenia nieuczciwym działaniom.

  • Aby wyświetlić konta wysyłkowe skojarzone z Twoim identyfikatorem użytkownika, przejdź na stronę Administrator przesyłki. Aby utworzyć nowe konta wysyłkowe, skontaktuj się z przedstawicielem handlowym FedEx.

Zrzut ekranowy strony „Dodaj konto wysyłkowe”
  1. umowa licencyjna użytkownika końcowego
Zrzut ekranowy strony „Podpisz EULA”

Krok 5:

Dodaj użytkowników do organizacji, aby rozpocząć współpracę z członkami zespołu.

Administrator może zapraszać użytkowników do organizacji oraz przypisywać im role i projekty. Aby rozpocząć, kliknij przycisk „Dodaj użytkowników” na karcie Użytkownicy na stronie Zarządzaj organizacją. Na tym etapie możesz dodać użytkowników, wykonując następujące czynności (kroki oznaczone gwiazdką * są opcjonalne):

  1. Wpisz adresy e-mail użytkowników, którzy powinni dołączyć do organizacji. Wprowadź wiele adresów e-mail, naciskając klawisz spacji, przecinka, średnika lub Enter na klawiaturze.
  2. Wybierz rolę, jeśli domyślna opcja przeglądającego nie odpowiada potrzebom użytkowników*.
  3. Wybierz skojarzony z organizacją projekt, do którego chcesz przypisać użytkowników. Jeśli jeszcze nie utworzono projektu, omówimy to w następnym kroku*.
Zrzut ekranowy strony „Dodaj użytkowników”

Administrator zawsze ma dostęp do wszystkich projektów, ale współautor lub przeglądający musi być przypisany do projektu, chyba że współautor utworzył projekt. Niezależnie od tego, czy użytkownik zaakceptował zaproszenie, czy nie, możesz szybko zaktualizować jego projekty lub role bezpośrednio na karcie Użytkownicy na ekranie Administracja organizacji. Wystarczy kliknąć znak karetki obok roli lub projektu, a pojawi się menu rozwijane z opcjami do wyboru. Dokonaj wyboru i kliknij przycisk „Zastosuj”, aby zapisać wybór.

Zrzut ekranowy strony „Zarządzaj organizacją”

Krok 6:

Utwórz projekt, aby uzyskać poświadczenia.

Na stronie Moje projekty administrator lub współautor może utworzyć projekt, wybierając przycisk „Utwórz projekt”. Na tym etapie można rozpocząć tworzenie projektu, wykonując następujące czynności (kroki oznaczone gwiazdką * są opcjonalne):

1.  Konfigurowanie projektu        

  • Nadaj projektowi rozpoznawalną nazwę, która nie powtarza się w organizacji.
  • Zacznij od wybrania co najmniej jednego interfejsu API do dodania do projektu. Zawsze możesz później dodać lub usunąć interfejsy API.
Zrzut ekranowy kroku 1 tworzenia projektu 

2. Akceptowanie warunków

Zrzut ekranowy kroku 2 tworzenia projektu
       
         3.  Ustawienia projektu
 
  • Wybierz kraje, do których chcesz wysyłać, a przypiszemy Ci testowe konto wysyłkowe. Aby przetestować wysyłanie paczek w granicach kraju w Europie, musisz mieć oddzielne konto testowe dla każdego kraju. Kraje możesz dodawać/usuwać później.*
  • Jeśli planujesz użyć zwrotów FedEx SmartPost® lub ładunków częściowych FedEx Freight®, wybierz opcję Tak.*
  • Po kliknięciu przycisku „Utwórz” zostanie wyświetlony ekran potwierdzenia. W ramach nowego projektu możesz teraz wyświetlić poświadczenia testowe.
Zrzut ekranowy kroku 3 tworzenia projektu

Krok 7:

Zintegruj interfejsy API z aplikacją i przetestuj to wdrożenie.

  1. Pobierz poświadczenia testowe (klucz API, klucz tajny i konta wysyłkowe) z karty Klucz testowy na stronie Przegląd projektu.
Zrzut ekranowy strony z kluczami testowymi
  1. Poproś o token dostępu OAuth, który musi być używany z każdą transakcją 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.
  2. 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ą.
  3. 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.
  4. Upewnij się,że odebrane odpowiedzi na wywołania interfejsu API są zgodne z tymi podanymi w dokumentacji.
  5. W pełni przetestuj swoje wdrożenie w środowisku testowym FedEx, używając poświadczeń testowych i identyfikatorów URI FedEx.

Krok 8:

Przenieś projekt do środowiska produkcyjnego.

Na stronie Przegląd projektu kliknij kartę Klucz produkcyjny. Na tym etapie możesz rozpocząć przenoszenie projektu do środowiska produkcyjnego, wykonując następujące czynności (kroki oznaczone gwiazdką * są opcjonalne):

  1. Skonfiguruj projekt.
  • Zmień nazwę klucza produkcyjnego interfejsu API*.
  • W tym momencie trzeba dodać jedno konto wysyłkowe, ale możesz dodać ich więcej po pomyślnym przeniesieniu projektu do środowiska produkcyjnego. Jeśli z organizacją nie skojarzono żadnych kont wysyłkowych lub jeśli dla kont wysyłkowych dodanych do organizacji nie podpisano EULA, nie pojawią się one w menu rozwijanym.
Zrzut ekranowy kroku 1 na stronie kluczy produkcyjnych
  1. Pobierz klucze projektów.
  • Następnie zostaną wyświetlone klucz produkcyjny interfejsu API i produkcyjny klucz tajny. Koniecznie skopiuj je w bezpieczne miejsce.
  • Ze względów bezpieczeństwa tylko raz wyświetlamy produkcyjny klucz tajny. Jeśli go zgubisz, możesz wygenerować nowy.
Zrzut ekranowy kroku 2 na stronie kluczy produkcyjnych

Krok 9:

Sfinalizuj integrację.

  1. Niektóre interfejsy API wymagają podstawowej certyfikacji lub 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.
Zrzut ekranowy strony certyfikacyjnej
  1. Po certyfikowaniu i włączeniu wszystkich interfejsów API zaktualizuj żądania interfejsów API, zastępując testowe identyfikatory URI, klucze i konta wysyłkowe produkcyjnymi identyfikatorami URI, kluczami i kontami wysyłkowymi.
  2. Ponownie przetestuj wdrożenie w środowisku produkcyjnym, używając przykładowych danych.
  3. Możesz już korzystać z tej nowej integracji!


Krok 1. 

FedEx tworzy organizację dostawcy Compatible.

  • 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.

Krok 2:

Zaakceptuj zaproszenie.

  • 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ń.
zrzut ekranu strony rejestrowania się, aby rozpocząć integrację z interfejsami API FedEx

Krok 3:

Zaproś użytkowników do swojej organizacji.

  • 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ą.
zrzut ekranu strony zarządzania użytkownikami organizacji
  • 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.

Krok 4:

Wybierz interfejsy API, których potrzebujesz do swojego rozwiązania.

  • 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.

zrzut ekranu strony katalogu interfejsów API
  • Wybierz interfejs API, aby zobaczyć jego omówienie, dzienniki zmian i kluczowe funkcje.

zrzut ekranu strony przeglądu interfejsu API weryfikacji adresów
  • 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.

zrzut ekranu strony dokumentacji interfejsu API weryfikacji adresów
  • 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.


Krok 5:

FedEx tworzy projekty.

Po zatwierdzeniu arkusza PIW FedEx utworzy Twoje projekty. Każda wersja każdego z Twoich rozwiązań będzie mieć osobny projekt w portalu programistów FedEx. 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.


Krok 6:

Zintegruj interfejsy API ze swoją aplikacją i uzyskaj certyfikat zgodności z programem Compatible.

  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).
zrzut ekranu strony przeglądu projektu z kartą klucza testowego
  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).
zrzut ekranu strony z listą rozwijaną „samples” przykładowego kodu dla interfejsu API rejestracji poświadczeń
  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.

Krok 7:

FedEx przenosi projekty do środowiska produkcyjnego.

  • Następnie FedEx przeniesie projekty do środowiska produkcyjnego.
  • Wówczas produkcyjny klucz API będzie widoczny na karcie Production (Produkcja) na stronie Project Overview (Przegląd projektu).
zrzut ekranu wersji zgodnych rozwiązań z łączem generowania wyświetlanym na stronie przeglądu projektu z kartą wersji produkcyjnej

Krok 8:

Wygeneruj produkcyjny klucz tajny.

  • Produkcyjny klucz tajny należy wygenerować, klikając łącze Generate Secret (Wygeneruj klucz tajny) w kolumnie Secret Key (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!