Skip to main content

​
Sobre a API Open Delivery

A API Open Delivery segue o padrão Open Delivery, um protocolo aberto para integração entre aplicativos de pedidos e serviços logísticos. Esta API utiliza autenticação OAuth 2.0 com o fluxo Client Credentials, oferecendo uma integração padronizada e compatível com o ecossistema Open Delivery. Você pode acessar nossa página oficial no Open Delivery pelo link: 🔗 Husky no Open Delivery

​
Configuração Inicial

​
Passo 1: Escolha o Ambiente

A API está disponível em dois ambientes:

Sandbox

Base URL: https://sandbox.opendelivery.gohusky.net/logisticAmbiente de testes e homologação.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://opendelivery.gohusky.net/logisticAmbiente de produção. Use após concluir a homologação.

​
Passo 2: Autenticação OAuth 2.0

A API Open Delivery utiliza OAuth 2.0 com o fluxo Client Credentials para autenticação.
Para obter um token de acesso, faça uma requisição POST para o endpoint /oauth/token:Parâmetros necessários:
  • grant_type: client_credentials
  • client_id: Seu ID de cliente fornecido pela Husky
  • client_secret: Seu secret de cliente fornecido pela Husky
Resposta:
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
  "token_type": "Bearer",
  "expires_in": 604800
}
O token expira em 7 dias (604800 segundos).
Após obter o token, inclua-o no header Authorization de todas as requisições:
Authorization: Bearer {access_token}
Todos os endpoints protegidos requerem este token no header.
Mantenha suas credenciais (client_id e client_secret) seguras. Nunca as exponha em código cliente ou repositórios públicos.

​
Fluxo Operacional da Integração

​
Resumo do Processo

1

Obter Token de Acesso

Primeiro, obtenha um token de acesso através do endpoint /oauth/token usando suas credenciais OAuth.Este token será necessário para todas as requisições subsequentes.
2

Cotação de Entrega (Opcional)

Antes de criar a entrega, você pode consultar a disponibilidade e obter uma cotação através do endpoint /v1/logistics/availability.Este endpoint retorna informações sobre disponibilidade, preço estimado e tempo de entrega.
3

Criar Nova Entrega

Crie a entrega através do endpoint /v1/logistics/delivery.Neste momento são informados os dados principais:
  • orderId: Identificador único do pedido
  • merchant: Dados do estabelecimento
  • pickupAddress: Endereço de coleta
  • deliveryAddress: Endereço de entrega
  • Informações de pagamento e configurações do veículo
A requisição é processada de forma assíncrona e retorna status 202 (Accepted) quando a entrega é aceita para processamento.A resposta inclui um deliveryId que deve ser usado para rastrear o status da entrega.
4

Pedido Pronto para Coleta

Quando o pedido estiver pronto para ser coletado, informe através do endpoint /v1/logistics/delivery/{orderId}/ready-for-pickup.Este endpoint notifica o sistema logístico que o pedido está pronto para ser coletado pelo entregador.
5

Receber Atualizações via Webhook

A API Open Delivery envia atualizações de status através de webhooks.Configure seu endpoint para receber eventos de tracking através do webhook tracking-event.Os eventos incluem atualizações de status, localização do entregador e conclusão da entrega.
6

Consultar Detalhes da Entrega

A qualquer momento, você pode consultar os detalhes completos de uma entrega através do endpoint /v1/logistics/delivery/{orderId}.Este endpoint retorna todas as informações relacionadas à entrega, incluindo status, eventos, informações do entregador e problemas reportados (se houver).

​
Endpoints Principais

Autenticação

Obtenha um token de acesso OAuth 2.0 usando Client Credentials.Token válido por 7 dias.

Cotação de Entrega

Consulte disponibilidade, preço estimado e tempo de entrega antes de criar o pedido.

Criar Entrega

Crie uma nova solicitação de entrega no sistema logístico.Processamento assíncrono com resposta 202 (Accepted).

Detalhes da Entrega

Consulte informações completas sobre uma entrega específica, incluindo status, eventos e entregador.

Pedido Pronto

Informe que o pedido está pronto para ser coletado pelo entregador.

Webhooks

Configure seu endpoint para receber eventos de tracking e atualizações de status.

​
Ações Adicionais Disponíveis

Além dos endpoints principais, a API Open Delivery oferece ações específicas para gerenciar o ciclo de vida das entregas:

Pedido Coletado

Informe quando o entregador coletou o pedido no estabelecimento.

Finalizar Entrega

Finalize a entrega quando o pedido for entregue ao cliente.

Tratar Problema

Reporte e trate problemas ocorridos durante a entrega.

Cancelar Entrega

Cancele uma entrega que não pode ser realizada.

​
Validação de Sucesso

Importante: A requisição de criação de entrega retorna status 202 (Accepted) quando a entrega é aceita para processamento.Verifique o deliveryId retornado na resposta para confirmar que a entrega foi criada com sucesso. Use este ID para consultar os detalhes e rastrear o status da entrega.

​
Possíveis Retornos

  • HTTP 200 - Requisição bem-sucedida
  • HTTP 202 - Entrega aceita para processamento (criação de entrega)
  • HTTP 400 - Erro na validação dos dados enviados
  • HTTP 401 - Token inválido ou ausente
  • HTTP 404 - Recurso não encontrado

​
Próximos Passos

Autenticação

Entenda em detalhes como funciona a autenticação OAuth 2.0 na API Open Delivery.

Criar Entrega

Aprenda a criar entregas com todos os parâmetros disponíveis.

Webhooks

Configure e entenda todos os eventos de webhook disponíveis.

API Pública

Se preferir usar nossa API Pública, consulte a documentação específica.
Precisa de ajuda? Entre em contato com nosso suporte em suporte@gohusky.net ou consulte a documentação completa do Open Delivery.