Documentação da API

Guia completo para integrar com a API de rastreamento

Visão Geral da API

Informações básicas sobre a API de rastreamento

A API de Rastreamento permite que você integre o sistema de rastreamento de pedidos com suas aplicações. Com ela, você pode:

  • Criar novos pedidos com códigos de rastreio
  • Atualizar o status de pedidos existentes
  • Consultar informações de pedidos
  • Receber webhooks para atualizações de status

URL Base

http://localhost:3000/api

Formatos de Resposta

Todas as respostas são retornadas no formato JSON. Cada resposta inclui um campo success que indica se a requisição foi bem-sucedida.

Códigos de Status HTTP

  • 200 OK - A requisição foi bem-sucedida
  • 201 Created - Um novo recurso foi criado com sucesso
  • 400 Bad Request - A requisição contém parâmetros inválidos
  • 401 Unauthorized - Autenticação necessária ou inválida
  • 404 Not Found - O recurso solicitado não foi encontrado
  • 500 Internal Server Error - Erro interno do servidor