API da Twendex
Integre a logística na sua aplicação. O mesmo motor que faz funcionar a Twendex — envios, preços, seguimento, webhooks — através de uma API REST.
O que pode construir
A API da Twendex dá à sua aplicação acesso ao mesmo motor de logística usado por milhares de empresas em África. Crie envios, obtenha preços em directo, atribua transportadores, siga entregas e receba eventos de webhook — tudo numa API REST.
Criar e gerir envios
Crie envios, peça preços, aceite propostas e atribua transportadores por programa — igual à aplicação Twendex.
Webhooks em tempo real
Receba eventos de webhook assinados em cada fase do envio: criado, com preço, atribuído, a caminho, entregue.
Acesso limitado por âmbito
As chaves da API limitam-se aos seus recursos. O acesso entre contas está bloqueado. Há limites de utilização por nível.
Gestão autónoma
Crie, troque e apague chaves da API no painel. Registe endpoints de webhook. Acompanhe a utilização — sem aprovação manual.
Início de sessão
# All API requests require an API key
curl -H "X-API-Key: twx_live_xxxxxxxxxxxx" \
https://api.twendex.com/api/v1/platform/shipments
# Or use Bearer token
curl -H "Authorization: Bearer twx_live_xxxxxxxxxxxx" \
https://api.twendex.com/api/v1/platform/shipmentsEndereço base: https://api.twendex.com/api/v1
Começar depressa
Obter uma chave da API
Inicie sessão na sua conta Twendex, vá ao painel de programador e crie uma chave de teste. O segredo aparece só uma vez — copie-o logo.
Crie o seu primeiro envio
Faça um pedido POST a /api/v1/platform/shipments com a sua chave no cabeçalho X-API-Key. Inclua recolha, entrega e dados do volume no corpo do pedido.
Receba propostas e escolha um transportador
Consulte GET /api/v1/platform/shipments/{id}/quotes para ver as propostas. Aceite uma enviando para o endpoint de atribuição.
Seguir e receber webhooks
Use GET /api/v1/platform/tracking/{shipmentId} para a localização em directo. Registe um webhook para receber cada mudança de estado até à prova de entrega.
Modo de teste
As chaves de teste permitem experimentar toda a API sem tocar em transportadores reais, dinheiro ou despacho. Os envios de teste estão separados dos dados reais.
- Crie uma chave de teste no painel de programador (escolha o ambiente 'sandbox').
- Todos os envios de teste ficam em modo de teste — nenhum transportador real é enviado, nenhum pagamento real é processado.
- Use os mesmos endpoints e fluxo da produção. Mude para uma chave real quando estiver pronto.
Documentação interactiva da API
Explore cada endpoint, veja os formatos de pedido e resposta e teste directamente no navegador com a nossa documentação Swagger.
Abrir documentação da APIJá tem conta? Faça a gestão das chaves e webhooks no painel.
Ir para o painel de programador