Com o frete por API, você mantém suas regras de frete no seu próprio sistema de logística e integra esse sistema à Yampi. Na hora da compra, a Yampi consulta a sua API e mostra para o cliente as opções de frete que ela retornar.
💡 Os detalhes técnicos da integração estão na documentação Logística: API de frete.
Neste artigo, vamos mostrar:
Como configurar o frete por API?
No painel, acesse Configurações → Logística → + Novo frete.
Selecione a modalidade API.
Na página de configuração, preencha os campos do formulário:
Nome: o nome do frete, por exemplo, "Frete padrão";
URL: o endereço da sua API, para onde a Yampi envia a requisição de cotação. É por essa URL que a Yampi recebe as opções de frete que vão aparecer no checkout;
Headers: se a sua API usa autenticação por headers, informe aqui a Chave e o Valor, de acordo com o padrão de autenticação do seu sistema. Você pode cadastrar até 5 headers clicando em + Adicionar header.
⚠️ Atenção: a sua API precisa responder a cotação em até 4 segundos. Se passar desse tempo, a Yampi interrompe a requisição.
Como o alias do frete é montado?
O alias é o identificador do frete que aparece no checkout e no painel. É ele que você usa para mapear o frete em outros sistemas, como um ERP.
No frete por API, o alias é formado pelo nome e pelo serviço que a sua API retorna na cotação, em letras maiúsculas e separados por underline (_). Por exemplo:
Nome: Correios Pac
Serviço: Contrato Ag 03298
Alias: CORREIOS_PAC_CONTRATO_AG_03298
💡 Usa o Bling? Veja como mapear o alias no artigo Como configurar o alias de frete no Bling?
Como validar as requisições da Yampi?
Depois de criar o frete por API, a Yampi mostra uma chave secreta. Com ela, a sua API consegue confirmar que a requisição veio mesmo da Yampi, validando a assinatura enviada no header X-Yampi-Hmac-SHA256.
Veja como fazer essa validação na documentação Logística: API de frete.
Dúvidas frequentes 🤔
▶️ Clique na setinha de cada um para abrir o conteúdo*
Como sei qual alias o meu frete por API vai ter?
Como sei qual alias o meu frete por API vai ter?
O alias junta o nome e o serviço que a sua API retorna, em maiúsculas e separados por underline. Por exemplo, nome "Correios Pac" e serviço "Contrato Ag 03298" formam o alias CORREIOS_PAC_CONTRATO_AG_03298.
Quantos headers de autenticação posso cadastrar?
Quantos headers de autenticação posso cadastrar?
Até 5. Para incluir cada um, clique em + Adicionar header na configuração do frete.
Quanto tempo a minha API tem para responder a cotação?
Quanto tempo a minha API tem para responder a cotação?
Até 4 segundos. Depois disso, a Yampi interrompe a requisição.
Em caso de dúvidas, clique no balãozinho de atendimento em seu painel ou nos encaminhe pelo e-mail para [email protected] 😉