Złącze Shippo

Integracja z interfejsem API Shippo

Wprowadzenie

Shippo to interfejs API i aplikacja internetowa dla wielu przewoźników, która obejmuje takich przewoźników jak USPS, DHL, FedEx i wielu innych. Klienci mogą uzyskać stawki wysyłki, drukować etykiety, automatyzować dokumenty międzynarodowe, śledzić przesyłki i ułatwiać zwroty.

Cel

Ta integracja podkreśla, w jaki sposób można wykorzystać funkcje łącznika HTTP Tulip do integracji z interfejsem API Shippo w celu zautomatyzowania tworzenia przesyłek, uzyskiwania różnych stawek od wielu przewoźników, wybierania najlepszej stawki i wreszcie tworzenia i drukowania etykiety wysyłkowej wraz z opcją śledzenia przesyłek. Wszystko to można zrobić z poziomu aplikacji Tulip. W zależności od różnych przypadków użycia, integrację z Tulip można wykorzystać, aby mieć kontrolę nad operacjami łańcucha dostaw i mieć widoczność w czasie rzeczywistym podczas wysyłania paczek.

Dokumentacja API

Dokumentacja API Shippo

Wymagania wstępne

Utwórz konto na stronie Shippo i wygeneruj tokeny API, które będą używane jako nagłówki autoryzacji we wszystkich połączeniach wykonywanych do API Shippo. Shippo umożliwia wygenerowanie tokenu testowego i tokenu Live. Token testowy może być wykorzystany do wykonywania testowych wywołań HTTP z API i projektowania aplikacji Tulip, gdy aplikacja będzie gotowa, tokeny mogą być przełączane, a aplikacje mogą być wdrażane w produkcji w celu generowania etykiet wysyłkowych, transakcji w czasie rzeczywistym.

Szczegóły połączenia Tulip

Konektor HTTP Tulip musi być skonfigurowany z następującymi szczegółami w celu nawiązania połączenia z Shippo.

1. Uruchomione na: Host konektora w chmurze
2. Host: api.goshippo.com
3. Port:443
4. TLS:Tak
5. Tokeny Shippo jako nagłówek autoryzacji mogą być przekazywane za pośrednictwem funkcji konektora

Funkcja Connector

Utwórz przesyłkę

Cel

1. Ta funkcja konektora tworzy nową przesyłkę, wykonując wywołanie POST do interfejsu API Shippo z danymi nadawcy, danymi odbiorcy i szczegółami paczki będącymi częścią treści żądania.
2. Po pomyślnym utworzeniu Shippo zwraca obiekt JSON, który zawiera status utworzonej przesyłki wraz z wyborem stawek od różnych dostawców, które użytkownicy mogą wykorzystać, aby przejść dalej i zainicjować transakcję. Użytkownicy mogą wybrać odpowiednią stawkę, przechowywać identyfikatory stawek w zmiennych Tulip, które będą dynamicznie przekazywane do tworzenia transakcji w celu wygenerowania etykiety przesyłki w odpowiedniej funkcji łącznika.

Punkt końcowy

1. Wywołanie HTTP POST do punktu końcowego: https://api.goshippo.com:443/shipments/

Nagłówek autoryzacji

W celu uwierzytelnienia za pomocą API Shippo, token HTTP Shippo musi zostać przekazany do nagłówka żądania. Poniżej przedstawiono format

Autoryzacja: ShippoToken ($ShippoToken$)

Wymagane dane wejściowe

Poniżej przedstawiono parametry wejściowe, które są przekazywane w treści żądania, gdzie JSON jest typem zawartości.

1. Nazwa nadawcy, ulica, miasto, stan, kod pocztowy, kraj.
2. Nazwa odbiorcy, ulica, miasto, stan, kod pocztowy, kraj.
3. Wymiary paczki - długość, szerokość, szerokość i waga

Wymagany ekstraktor wyjściowy

Wiele informacji jest zwracanych dla utworzonego obiektu Shipment, jednak ważne pola, które należy wyodrębnić, są wymienione poniżej

1. Status: Wskazuje, czy przesyłka została pomyślnie utworzona.
2. ID przesyłki: Można się do niego odwołać, aby uzyskać szczegółowe informacje o utworzonej przesyłce.
3. Opcje stawek: Tablica obiektów wskazujących różne opcje stawek dostarczanych przez różnych dostawców. Identyfikator stawki jest ważnym kluczem między innymi do wyodrębnienia, który zostanie przekazany w celu utworzenia rzeczywistej transakcji dla tej przesyłki.

Utwórz transakcję

Cel

1. Ta funkcja łącznika tworzy transakcję po wybraniu dostawcy i ostatecznej stawki z różnych opcji, które zostały zwrócone podczas tworzenia nowej przesyłki w poprzedniej funkcji łącznika.
2. Pomyślna transakcja jest ustanawiana poprzez wykonanie wywołania POST HTTP do punktu końcowego Shippo, przekazując identyfikator powiązany z ustaloną stawką. Po pomyślnym wywołaniu Shippo zwraca obiekt JSON, który zawiera między innymi status transakcji, identyfikator śledzenia, etykietę wysyłkową i adres URL śledzenia. Zwróconą etykietę wysyłkową można wydrukować bezpośrednio z aplikacji Tulip.

Punkt końcowy

1. Wywołanie HTTP POST do punktu końcowego: https://api.goshippo.com:443/transactions/

Nagłówek autoryzacji

W celu uwierzytelnienia za pomocą API Shippo, token HTTP Shippo musi zostać przekazany do nagłówka żądania. Poniżej przedstawiono format

Autoryzacja: ShippoToken ($ShippoToken$)

Wymagane dane wejściowe

Poniżej przedstawiono parametry wejściowe, które są przekazywane w treści żądania, gdzie JSON jest typem zawartości.

1. Identyfikator stawki: Przekazanie identyfikatora stawki wybranej do kontynuowania w celu utworzenia udanej transakcji.

Wymagany ekstraktor danych wyjściowych

Wiele informacji jest zwracanych dla utworzonego obiektu Shipment, jednak ważne pola do wyodrębnienia są wymienione poniżej

1. Status: Wskazuje, czy transakcja została pomyślnie utworzona
2. Identyfikator transakcji: Można się do niego odwołać, aby uzyskać szczegóły wykonanej transakcji.
3. Numer śledzenia: Umożliwia śledzenie przesyłki
4. Adres URL śledzenia: Adres URL strony śledzenia wybranego dostawcy.
5. Adres URL etykiety: Etykieta wysyłkowa, którą można osadzić w aplikacji Tulip w celu wydrukowania.