Pular para o conteúdo principal
Uma chave de API deixa o sistema da sua rede (ERP, loja virtual, agenda) fazer pela API o que você faz no painel: cadastrar e atualizar itens, estimar o custo e disparar alertas, consultar o saldo. A chave identifica o sistema, não uma pessoa, e vale para as unidades que você escolher. Só o dono da rede vê Integrações no menu e gerencia as chaves.

​
Criar uma chave

1

Abra Integrações e clique em Nova chave

Dê um Nome para reconhecer a chave depois, como “ERP Loja Centro”.
2

Escolha as unidades

Todas as unidades, inclusive as futuras, para o sistema central da rede, ou Unidades escolhidas, para liberar só algumas lojas a um parceiro.
3

Marque as permissões

São as mesmas da equipe, com três diferenças: toda chave consulta as unidades que alcança; Disparar eventos debita créditos como um disparo feito no painel; Gerenciar créditos, na API, só consulta saldo e extrato (a compra fica no painel).
4

Defina a expiração do token, se quiser

Expiração do token: sem expiração, 30, 90, 180 ou 365 dias. Um token expirado para de funcionar até você emitir outro.
5

Copie o token

Ao clicar em Criar chave, o diálogo Token da chave mostra o token uma única vez. Use Copiar token e guarde-o no sistema que vai chamar a API antes de clicar em Concluído.
O token é como uma senha da sua rede. Nunca o coloque em código de site, de aplicativo ou em mensagem. Se perder, emita um token novo e revogue o anterior.

​
Editar uma chave

Em Ver detalhes, Editar muda o nome, as unidades e as permissões. O token continua o mesmo: o sistema não precisa ser atualizado.

​
Trocar o token sem parar o sistema

Uma chave pode ter dois tokens ativos ao mesmo tempo, para a troca não deixar o sistema sem acesso.
1

Emita o token novo

No detalhe da chave, Emitir token. Copie-o: ele também aparece uma vez só.
2

Atualize o sistema

Troque o token no sistema da rede e confira que ele continua funcionando.
3

Revogue o antigo

Na tabela Tokens, Revogar token no token antigo. Quem ainda o usasse perde o acesso na hora.

​
Revogar uma chave

Revogar chave desliga todos os tokens da chave na hora. A chave fica na lista como Revogada, para histórico, e não pode ser reativada: crie outra.
Último uso mostra a chamada mais recente entre os tokens ativos da chave. O uso de um token revogado deixa de contar, e um token recém-emitido só aparece depois da primeira chamada.

​
Onde a API aparece no painel

O que o sistema faz pela chave aparece no painel com o selo API e o nome da chave: na coluna de autor dos disparos, no extrato de créditos e em Criado por, no detalhe do item. Os créditos consumidos são os mesmos: 1 por pessoa avisada. Os itens criados pela API trazem a Referência externa (SKU), o código do item no sistema da rede. Você também pode preenchê-la à mão, no formulário do item, para o sistema encontrar um item que você cadastrou no painel.

Documentação da API

Para quem vai programar a integração: autenticação, primeira requisição e a referência de todos os endpoints.