Коннектор Shippo

Интеграция с API Shippo

Введение

Shippo - это API и веб-приложение для доставки грузов несколькими перевозчиками, включая USPS, DHL, FedEx и многих других. Клиенты могут получать тарифы на доставку, печатать этикетки, автоматизировать оформление международных документов, отслеживать отправления и осуществлять возврат.

Назначение

Данная интеграция показывает, как можно использовать функции HTTP-коннектора Tulip для интеграции с API Shippo, чтобы автоматизировать создание отправлений, получение тарифов от различных перевозчиков, выбор оптимального тарифа, создание и печать этикетки, а также возможность отслеживания отправлений. Все это можно сделать из вашего приложения Tulip. В зависимости от конкретной ситуации, интеграция с Tulip может быть использована для контроля над цепочкой поставок и отслеживания отправлений в режиме реального времени.

Документация по API

Документация по API Shippo

Предварительные требования

Создайте учетную запись на сайте Shippo и сгенерируйте API-токены, которые будут использоваться в качестве заголовков авторизации во всех обращениях к API Shippo. Shippo позволяет генерировать тестовый и реальный токены. Тестовый токен можно использовать для выполнения тестовых HTTP-вызовов с API и разработки приложения Tulip. После того как приложение будет готово, токены можно поменять местами и развернуть приложение в производстве для создания этикеток отгрузки и транзакций в режиме реального времени.

Детали подключения Tulip

Для установления соединения с Shippo HTTP-коннектор Tulip должен быть сконфигурирован со следующими данными.

1. Работает на: хосте облачного коннектора
2. Хост : api.goshippo.com
3. Порт:443
4. TLS:Да
5. Токены Shippo в качестве заголовка авторизации могут быть переданы через функцию коннектора

Функция коннектора

Создать груз

Назначение

1. Данная функция коннектора создает новое отправление путем POST-вызова API Shippo, при этом в теле запроса указываются данные отправителя, получателя и посылки.
2. При успешном создании Shippo возвращает JSON-объект, содержащий статус созданного отправления, а также выбор тарифов от различных поставщиков, которые пользователи могут использовать для продвижения и инициирования транзакции. Пользователи могут выбрать нужный тариф, сохранить идентификаторы тарифов в переменных Tulip, которые будут динамически передаваться для создания транзакции, чтобы сгенерировать этикетку груза в соответствующей функции коннектора.

Конечная точка

1. HTTP POST вызов конечной точки: https://api.goshippo.com:443/shipments/.

Заголовок авторизации

Для аутентификации в API Shippo в заголовке запроса необходимо передать HTTP-токен Shippo. Ниже приведен формат

Авторизация : ShippoToken ($ShippoToken$)

Необходимые входные параметры

Ниже перечислены входные параметры, которые передаются в теле запроса, где тип содержимого - JSON.

1. Имя отправителя, улица, город, штат, почтовый индекс, страна.
2. Имя получателя, улица, город, штат, почтовый индекс, страна.
3. Размеры пакета - длина, ширина, вес.

Требуемый выходной экстрактор

Для созданного объекта Shipment возвращается большое количество информации, однако ниже приведены важные поля, которые необходимо извлечь.

1. Статус: Указывает, успешно ли создано отправление
2. Идентификатор груза: Может быть использован для получения подробной информации о созданном грузе.
3. Rate Options (Опции тарифа): Массив объектов, указывающих на различные варианты тарифов, предоставляемых разными поставщиками. Идентификатор тарифа является важным ключом, который будет передан для создания фактической транзакции по данному грузу.

Создать транзакцию

Назначение

1. Данная функция коннектора создает транзакцию после выбора поставщика и конечного тарифа из различных вариантов, которые были получены при создании нового отправления в предыдущей функции коннектора.
2. Успешная транзакция создается путем выполнения HTTP-вызова POST на конечную точку Shippo с передачей идентификатора, связанного с выбранным тарифом. При успешном вызове Shippo возвращает JSON-объект, содержащий, помимо прочей информации, статус транзакции, идентификатор отслеживания, ярлык доставки и URL-адрес отслеживания. Полученная этикетка может быть распечатана непосредственно из самого приложения Tulip.

Конечная точка

1. HTTP POST вызов конечной точки: https://api.goshippo.com:443/transactions/.

Заголовок авторизации

Для аутентификации в API Shippo в заголовке запроса необходимо передать HTTP-токен Shippo. Ниже приведен формат

Авторизация : ShippoToken ($ShippoToken$)

Необходимые входные параметры

Ниже перечислены входные параметры, которые передаются в теле запроса, где тип содержимого - JSON.

1. ID тарифа: Передача идентификатора тарифа, выбранного для успешного проведения транзакции.

Экстрактор требуемых выходных данных

Для созданного объекта Shipment возвращается большое количество информации, однако ниже приведены важные поля, которые необходимо извлечь

1. Статус: Указывает, успешно ли создана транзакция
2. ID транзакции: Может быть использован для получения подробной информации о выполненной транзакции.
3. Номер отслеживания: Для отслеживания отправления
4. URL-адрес отслеживания: URL страницы отслеживания выбранного поставщика.
5. URL-адрес этикетки: URL-адрес этикетки, которая может быть встроена в приложение Tulip для печати