Como gerar tokens da API Braavo!

A tela API Braavo! cria as credenciais que um sistema externo precisa para se comunicar com a sua loja. É o ponto de partida de qualquer integração: um ERP, um aplicativo próprio, um serviço contratado ou qualquer software que precise ler ou gravar pedidos, produtos, estoques e clientes pela API.

A tela fica em ERPs > API Braavo! e o acesso é restrito a administradores de nível 1.

Para entender como a API funciona, os verbos disponíveis, o limite de chamadas e como os webhooks se encaixam no fluxo, leia Onde encontrar o manual da API e dos Webhooks da Braavo.

Criando um token

Clique em Adicionar e preencha:

• Nome do Serviço — identifica para que serve este token, como "ERP Bling" ou "App próprio". Um nome claro facilita a gestão quando há mais de uma integração ativa ao mesmo tempo.
• E-mail do Técnico Responsável — recebe notificações urgentes de segurança relacionadas a este token. Use o contato de quem cuida da integração.

Configurando o Webhook

O webhook faz o caminho inverso da API: em vez de o sistema perguntar o que mudou, a loja avisa proativamente. Quando ativado, a loja envia uma requisição automática para a URL cadastrada sempre que um novo pedido é criado.

• Ativo — liga ou desliga o envio de eventos para este token.
• URL do Webhook (para Pedidos) — endereço no seu sistema que receberá os dados do pedido. A URL precisa estar no ar, aceitar requisições POST e responder com um código de sucesso (família 2xx) para confirmar o recebimento.

Atenção: existe um interruptor global de webhooks em Ajustes, acessível pela lista de tokens. Quando ele está desligado, nenhum webhook é disparado, independentemente das configurações individuais de cada token. Se os webhooks pararem de funcionar sem motivo aparente, verifique esse interruptor primeiro.

Anotando as credenciais

Ao salvar, a plataforma exibe uma única vez o API Token e o API Key. Esse é o único momento em que o API Key aparece em texto.

• API Token — funciona como o identificador do usuário na autenticação Basic.
• API Key — funciona como a senha. Nunca é exibido novamente após esta tela.

Atenção: anote os dois antes de sair. Se perder o API Key, o caminho é criar um token novo e atualizar a integração com as novas credenciais. O link para o manual técnico da API também aparece nessa tela, para facilitar o repasse ao responsável pela integração.

Editando um token

É possível atualizar o nome do serviço, o e-mail do responsável e a configuração de webhook a qualquer momento. Editar um token não altera o API Token nem o API Key, que são gerados apenas na criação.