Skip to main content

​
Sobre a API Pública

A API Pública foi desenvolvida para oferecer uma integração simples e eficiente entre operações logísticas e sistemas de pedidos. Por meio dela, é possível gerenciar usuários, empresas, dispositivos e fluxos de entrega, permitindo maior automação e controle operacional.

​
Configuração Inicial

​
Passo 1: Escolha o Ambiente

A API está disponível em dois ambientes:

Sandbox

Base URL: https://sandbox.api.gohusky.netAmbiente de testes e homologação.Use live_mode=false nas requisições.Para acessar, entre em contato com o suporte informando:
  • Nome do Responsável Técnico
  • E-mail
  • Nome da Empresa

Produção

Base URL: https://api.gohusky.netAmbiente de produção. Use após concluir a homologação.Use live_mode=true nas requisições.

​
Passo 2: Entenda a Autenticação

Todas as requisições à API da Husky devem ser autenticadas por meio de um token, enviado sempre nos HTTP Params (query parameters).
O token representa o ID público da operação.
  • Use quando quiser gerenciar recursos a nível de operação
  • Passe customer=false nos parâmetros
  • Exemplo: gerenciar múltiplas lojas, receber webhooks de todas as lojas
O token representa o ID público do Embarcador.
  • Use quando quiser gerenciar recursos de uma loja específica
  • Passe customer=true nos parâmetros
  • Exemplo: criar entregas de uma loja específica, receber webhooks apenas dessa loja
Para endpoints v2 (como /v2/getOrderStatus), o token deve ser enviado via Header com a chave Token.Não é necessário passar o parâmetro customer.
Cada endpoint especifica qual tipo de token deve ser utilizado. Verifique a documentação de cada endpoint antes de fazer a requisição.

​
Fluxo Operacional da Integração

​
Resumo do Processo

1

Pedido é criado no aplicativo de pedidos do Parceiro

O pedido é criado no sistema do parceiro (aplicativo de pedidos).
2

Criação do Pedido na Husky

O pedido é criado através do endpoint /createOrderList.Neste momento são informados os dados principais:
  • Identificação do pedido (orderId)
  • Dados do cliente (addresses.dropoff)
  • Forma de pagamento
  • Demais dados pertinentes à criação do pedido
Nosso sistema:
  • Valida o payload recebido
  • Se geocoding = true, realiza geocodificação automática do endereço
  • Se useSavedAddress = true, verifica na base de contatos se há endereço já cadastrado para o destinatário
  • Cria o pedido no lado da Husky
3

Pedido Pronto para Logística

Para informar que o pedido está pronto, utilize o endpoint /orderReady.Por padrão, o pedido é criado como “em preparo” do nosso lado, ficando a cargo do sistema parceiro informar que o pedido está pronto para a logística.
4

Recebimento de Atualizações de Status

Trabalhamos exclusivamente com Webhooks. O sistema parceiro deve cadastrar sua URL através do endpoint /notifications.Neste endpoint você configura a URL em que irá receber os webhooks de atualização de status das entregas.
5

Rastreio do Pedido

Para montar o link de rastreio do pedido, use o tracking_code retornado na criação da entrega:
https://entregas.gohusky.net/tracking?q={TRACKING_CODE}
O tracking_code é retornado no momento da criação da entrega através do endpoint /createOrderList.

​
Endpoints Principais

Cotação de Entrega

Calcule o valor e distância da entrega antes de criar o pedido.Rate Limit: 100 requisições por minuto

Criar Entrega

Crie uma entrega individual ou múltiplas entregas em lote.Suporta geocodificação automática e uso de endereços salvos.

Consultar Status

Consulte o status de uma ou múltiplas entregas (até 1000 por requisição).Rate Limit: 1 requisição a cada 30 segundos

Configurar Webhooks

Cadastre URLs para receber notificações de eventos.Eventos disponíveis: ORDER_STATUS_UPDATED, ORDER_CREATED, ORDER_UPDATED, entre outros.

​
Validação de Sucesso

Importante: A melhor forma de validar a criação da entrega é verificar se o TRACKING_CODE foi retornado na resposta.Na resposta, enviamos sempre um campo success. Quando este campo vier diferente de 1, ocorreu um problema com a criação e a requisição deve ser enviada novamente.

​
Possíveis Retornos

  • HTTP 401 - Sempre que um campo obrigatório não for enviado ou o token for inválido
  • HTTP 200 - Sempre que a solicitação for aceita, porém deve ser levado em conta se o TRACKING_CODE foi retornado

​
Próximos Passos

Documentação Completa

Explore todos os endpoints disponíveis na documentação completa da API Pública.

Open Delivery

Se preferir usar o padrão Open Delivery, consulte nossa documentação específica.

Autenticação

Entenda em detalhes como funciona a autenticação na API Husky.

Webhooks

Configure e entenda todos os eventos de webhook disponíveis.
Precisa de ajuda? Entre em contato com nosso suporte em suporte@gohusky.net ou consulte a documentação completa.