Visão geral
Com este recurso é possível conectar APIs externas de cálculo de frete para serviços que não são integrados nativamente na Yampi.
Como habilitar
Para habilitar este recurso, o lojista deve criar uma nova API de frete pelo painel da Yampi:
-
Acesse o menu:
Configurações > Logística > API de Frete
-
Clique em Criar nova API de Frete
-
Preencha os campos obrigatórios:
- Nome da API
- URL da API
- Headers (opcional)
Requisição enviada pela Yampi
Quando um comprador solicitar o cálculo de frete, a Yampi enviará uma requisição POST
para a URL cadastrada com o seguinte corpo:
Campos e descrições
Campo | Descrição |
---|---|
zipcode | CEP de entrega |
amount | Valor total do carrinho |
skus[].id | ID do SKU na Yampi |
skus[].product_id | ID do Produto na Yampi |
skus[].sku | Código do SKU |
skus[].price | Preço unitário do item |
skus[].quantity | Quantidade de itens |
skus[].length | Comprimento unitário do SKU |
skus[].width | Largura unitária do SKU |
skus[].height | Altura unitária do SKU |
skus[].weight | Peso unitário do SKU (em KG) |
skus[].availability_days | Prazo de postagem (em dias) |
skus[].platform.name | Nome da plataforma externa |
skus[].platform.external_id | ID do SKU na plataforma externa |
cart.promocode | Cupom de desconto (opcional) |
cart.customer.document | CPF ou CNPJ do cliente |
cart.customer.email | E-mail do cliente |
Resposta esperada
Sua API deverá obrigatoriamente responder no formato abaixo:
⚠️ Sua aplicação deve responder em até 4 segundos. Caso contrário, a Yampi abortará a requisição.
Segurança nas requisições
Para garantir que a requisição partiu da Yampi, é necessário validar a assinatura enviada no header.
Como validar:
- Pegue o valor do header
X-Yampi-Hmac-SHA256
- Gere a assinatura localmente usando
HMAC-SHA256
do corpo da requisição com a chave secreta da API de frete - Codifique em base64
- Compare o resultado com o valor recebido no header
Se a assinatura for igual ao valor do header, ✅ requisição é legítima.
Conclusão
Com essa integração, você pode oferecer opções de frete personalizadas no checkout da Yampi, mantendo controle sobre prazos, preços e validação de segurança.