Conector Shippo

Integração com a API do Shippo

Introdução

O Shippo é uma API de remessa de várias transportadoras e um aplicativo da Web que inclui transportadoras como USPS, DHL, FedEx, entre muitas outras. Os clientes podem obter taxas de remessa, imprimir etiquetas, automatizar documentos internacionais, rastrear remessas e facilitar devoluções.

Finalidade

Essa integração destaca como é possível aproveitar as funções do conector HTTP da Tulip para integrar-se à API da Shippo e automatizar a criação de remessas, obtendo uma variedade de tarifas de diversas transportadoras, escolhendo a melhor tarifa e, por fim, criando e imprimindo uma etiqueta de remessa com a opção de rastrear as remessas. Tudo isso pode ser feito a partir de seu aplicativo Tulip. Dependendo dos diferentes casos de uso, a integração com a Tulip pode ser aproveitada para ter controle sobre a operação da cadeia de suprimentos e ter visibilidade em tempo real do envio de pacotes.

Documento da API

Documentação da API do Shippo

Pré-requisitos

Criar uma conta no site da Shippo e gerar tokens de API que seriam usados como cabeçalhos de autorização em todas as chamadas feitas para a API da Shippo. O Shippo permite que você gere um token de teste e um token ativo. O token de teste pode ser aproveitado para fazer chamadas HTTP de teste com a API e projetar seu aplicativo Tulip, uma vez que o aplicativo esteja pronto, os tokens podem ser trocados e os aplicativos podem ser implantados na produção para gerar etiquetas de remessa, transações em tempo real.

Detalhes da conexão Tulip

O conector HTTP do Tulip precisa ser configurado com os seguintes detalhes para estabelecer uma conexão com o Shippo.

1. Em execução: host do conector de nuvem
2. Host: api.goshippo.com
3. Porta:443
4. TLS:Sim
5. Os tokens do Shippo como cabeçalho de autorização podem ser passados por meio da função do conector

Função do conector

Criar envio

Objetivo

1. Essa função do conector cria uma nova remessa fazendo uma chamada POST para a API do Shippo com detalhes do remetente, detalhes do destinatário e detalhes do pacote que fazem parte do corpo da solicitação.
2. Na criação bem-sucedida, o Shippo retorna um objeto JSON que inclui o status da remessa criada junto com uma escolha de taxas de diferentes fornecedores que os usuários podem aproveitar para avançar e iniciar uma transação. Os usuários podem selecionar a taxa correta, ter os IDs de taxa armazenados em variáveis Tulip que seriam passadas dinamicamente para criar a transação e gerar a etiqueta de remessa na função de conector correspondente.

Ponto final

1. Chamada HTTP POST para o ponto de extremidade: https://api.goshippo.com:443/shipments/

Cabeçalho de autorização

Para se autenticar com a API do Shippo, o token HTTP do Shippo precisa ser passado para o cabeçalho da solicitação. O formato é o seguinte

Autorização: ShippoToken ($ShippoToken$)

Entrada obrigatória

A seguir estão os parâmetros de entrada que são passados no corpo da solicitação, onde JSON é o tipo de conteúdo.

1. Nome do remetente, rua, cidade, estado, código postal, país.
2. Nome dos receptores, rua, cidade, estado, CEP, país
3. Dimensões do pacote - comprimento, largura, largura e peso

Extrator de saída necessário

Muitas informações são retornadas para o objeto Shipment criado; no entanto, os campos importantes a serem extraídos são mencionados abaixo

1. Status: Indica se a remessa foi criada com êxito
2. ID da remessa: Pode ser referenciado para obter os detalhes da remessa criada.
3. Opções de tarifa: Matriz de objetos que indicam diferentes opções de tarifas fornecidas por diferentes fornecedores. O ID da tarifa é a chave importante, entre outras a serem extraídas, que seria passada para criar a transação real para essa remessa.

Criar transação

Finalidade

1. Essa função de conector cria a transação depois de escolher o fornecedor e a taxa final entre as diferentes opções que foram retornadas ao criar uma nova remessa na função de conector anterior.
2. Uma transação bem-sucedida é estabelecida por meio de uma chamada HTTP POST para o ponto de extremidade do Shippo, passando o ID associado à taxa decidida. Em uma chamada bem-sucedida, o Shippo retorna um objeto JSON que inclui o status da transação, o ID de rastreamento, a etiqueta de remessa e a URL de rastreamento, entre outras informações. A etiqueta de remessa retornada pode ser impressa diretamente do próprio aplicativo Tulip.

Ponto final

1. Chamada HTTP POST para o ponto de extremidade: https://api.goshippo.com:443/transactions/

Cabeçalho de autorização

Para se autenticar com a API do Shippo, o token HTTP do Shippo precisa ser passado para o cabeçalho da solicitação. O formato é o seguinte

Autorização: ShippoToken ($ShippoToken$)

Entrada obrigatória

A seguir estão os parâmetros de entrada que são passados no corpo da solicitação em que JSON é o tipo de conteúdo.

1. ID da tarifa: passar o ID da tarifa escolhida para avançar e criar uma transação bem-sucedida.

Extrator de saída necessário

Muitas informações são retornadas para o objeto Shipment criado; no entanto, os campos importantes a serem extraídos são mencionados abaixo

1. Status: Indica se a transação foi criada com êxito
2. ID da transação: Pode ser consultado para obter os detalhes da transação executada.
3. Número de rastreamento: Para rastrear a remessa
4. URL de rastreamento: O URL da página de rastreamento do fornecedor escolhido
5. URL da etiqueta: Etiqueta de remessa que pode ser incorporada no aplicativo Tulip para impressão