Skip to main content

Bem-vindo

A API da Husky é uma plataforma de logística para delivery e entregas. Aqui você encontra todas as informações necessárias para integrar o sistema Husky em seu aplicativo ou sistema.

Ambientes

A API está disponível em dois ambientes:

Sandbox

https://sandbox.api.gohusky.net - Ambiente de Homologação, use para testes e desenvolvimento.

Produção

https://api.gohusky.net - Ambiente de Produção, use para produção.

Autenticação

Todas as requisições à API da Husky devem ser autenticadas por meio de um token. O token serve não só para autenticar a requisição, mas também para identificar se a requisição é de um embarcador ou de uma operação.
Por exemplo: Se for feito o cadastro de uma URL de webhook para eventos de entregas usando o token de um embarcador, só será notificado os eventos de entregas desse embarcador. Se for feito o cadastro de uma URL de webhook usando o token de uma operação, será notificado os eventos de entregas de todos os embarcadores.

Autenticação como Operação

Para autenticar como Operação, deve ser passado via query parameter o token da Operação e o customer com valor false.

Autenticação como Embarcador

Para autenticar como Embarcador, deve ser passado via query parameter o token do Embarcador e o customer com valor true.

Autenticação em endpoints v2

Para autenticar em endpoints v2, deve ser passado via header o token do Embarcador. Não precisa passar o customer.

Estrutura da Documentação

Esta documentação está organizada em seções para facilitar a navegação:
  • Embarcadores: Gerenciamento de embarcadores na plataforma
  • Entregas: Criação e gerenciamento de entregas
  • Entregadores: Informações sobre entregadores
  • webhooks: Configuração de notificações por webhook
Consulte a Especificação OpenAPI completa para mais detalhes sobre todos os endpoints disponíveis.