API Admin: credenciais para integrar sistemas à sua loja

A tela API Admin permite criar credenciais para que outros sistemas, como um ERP, uma plataforma de influenciadores ou a ferramenta de uma agência, se conectem à sua loja de forma automática e segura, sem depender do login de uma pessoa.

Cada aplicação funciona como um usuário do painel, só que para um sistema: ela tem um Client ID (o "login" da integração) e um Client secret (a "senha" da integração), e só consegue fazer o que os perfis de acesso atribuídos a ela permitem.

🧪 Funcionalidade em beta: a API Admin está em fase beta e, neste momento, é liberada apenas para algumas lojas. Caso tenha interesse em utilizar, entre em contato com o CS responsável pela sua conta.

ℹ️ Neste momento, as integrações por aplicação estão disponíveis para o cadastro e a edição de promoções, incluindo as consultas necessárias para isso, como produtos, categorias e marcas. Novas funcionalidades serão liberadas gradualmente.

A documentação técnica, para a equipe que vai desenvolver a integração, está disponível em https://wakecommerce.readme.io/reference/post_api-promotions e https://wakecommerce.readme.io/docs/promocoes-onde-obter-ids.

Antes de começar: permissões necessárias

O acesso à tela é controlado pelos perfis de acesso dos usuários do painel. Em Configurações > Controle de Acessos > Perfis de Acesso, abra o perfil desejado e localize Gestão Administrativa > Gestão de Aplicações. Lá estão duas permissões:

· Aplicações: com acesso de visualização, o usuário consulta a listagem. Com acesso de edição, também pode criar, editar, ativar, desativar e excluir aplicações.

· Segredos: permite visualizar, copiar e gerar um novo Client secret. Como o Client secret dá acesso à loja, recomendamos liberar essa permissão apenas para as pessoas responsáveis pelas integrações.

Permissões de Aplicações e Segredos no perfil de acesso.

Usuários sem permissão de edição veem a tela em modo somente leitura, com um aviso no topo. Para saber mais sobre perfis, consulte o artigo Perfis de acesso na plataforma.

Acessando a tela API Admin

Acesse a tela pelo endereço https://nomedaloja.fbits.app/integracoes/api-admin, trocando "nomedaloja" pelo nome da sua loja (o mesmo que aparece no endereço do seu painel). A tela exibe todas as aplicações cadastradas na loja.

· Busca: localize uma aplicação pelo nome ou pelo Client ID.

· Nome: nome da aplicação, com a descrição logo abaixo. Clicar no nome abre a edição.

· Client ID: identificador da aplicação, usado pela integração para se conectar.

· Criado por e Criado em: usuário que cadastrou a aplicação e a data do cadastro.

· Status: chave para ativar ou desativar a aplicação.

· Ações: menu com as opções Editar, Ver client secret e Excluir.

· + Nova aplicação: abre o cadastro de uma nova aplicação.

Tela API Admin, com a listagem de aplicações.

Menu de ações de uma aplicação.

Criando uma aplicação

1. Clique em + Nova aplicação.

2. Em Nome, informe um nome que identifique a integração, por exemplo "Integração Promoções" ou o nome do sistema parceiro.

3. O Client ID é sugerido automaticamente a partir do nome. O início dele é o identificador da sua loja e não pode ser alterado; o restante pode ser ajustado. Depois de salvar, o Client ID não pode mais ser alterado.

4. Em Descrição, explique para que serve a integração (até 200 caracteres). Isso ajuda a sua equipe a identificar a aplicação no futuro.

5. Mantenha a chave Ativa ligada para que a aplicação já possa ser usada.

6. Em Perfis de acesso, selecione um ou mais perfis. A aplicação só terá acesso ao que esses perfis permitem.

7. Clique em Salvar.

Cadastro de uma nova aplicação.

💡 Dica: crie um perfil de acesso específico para cada integração, liberando apenas o que ela precisa. Assim, a integração não tem acesso a informações além do necessário.

Guardando as credenciais

Ao salvar, a janela Aplicação criada exibe o Client ID e o Client secret. Use o botão Copiar secret e repasse as duas informações para a equipe responsável pela integração.

⚠️ Atenção: o Client secret funciona como uma senha. Guarde-o em local seguro e compartilhe apenas com quem vai configurar a integração. Ele pode ser consultado depois, na edição da aplicação, por usuários com a permissão Segredos.

Editando uma aplicação

Clique no nome da aplicação ou em Ações > Editar. É possível alterar o nome, a descrição, o status e os perfis de acesso. O Client ID fica bloqueado, mas pode ser copiado pelo ícone ao lado do campo.

Edição de uma aplicação.

Alterações nos perfis de acesso mudam o que a integração consegue fazer. Antes de remover um perfil, confirme com a equipe responsável se ele ainda é necessário.

Client secret: consultar e gerar um novo

Na edição da aplicação, o bloco Client secret mostra a chave oculta. Usuários com a permissão Segredos podem:

· Visualizar: pelo ícone de olho.

· Copiar: pelo ícone ao lado.

· Gerar novo secret: cria uma nova chave e invalida a anterior.

O Client secret também pode ser consultado direto na listagem, em Ações > Ver client secret.

Bloco do Client secret e opção de exclusão, na edição da aplicação.

Gere um novo secret quando houver suspeita de que a chave foi exposta ou quando a integração mudar de responsável.

Confirmação para gerar um novo Client secret.

⚠️ Atenção: ao gerar um novo secret, a chave anterior deixa de funcionar na hora. A integração fica parada até ser atualizada com a nova chave, por isso combine o momento da troca com a equipe responsável.

Ativando e desativando uma aplicação

Use a chave da coluna Status na listagem, ou a chave Ativa na edição. Uma confirmação é exibida antes da alteração.

· Ao desativar: a aplicação perde o acesso imediatamente e a integração para de funcionar.

· Ao reativar: a aplicação volta a funcionar com o mesmo Client ID, o mesmo Client secret e os perfis que já estavam atribuídos.

Confirmação para desativar uma aplicação.

Desativar é a melhor opção para pausar uma integração temporariamente, por exemplo, durante a troca de um fornecedor.

Excluindo uma aplicação

Use Ações > Excluir na listagem ou o botão Excluir aplicação no final da edição. Uma confirmação é exibida antes da exclusão.

Confirmação de exclusão de uma aplicação.

⚠️ Atenção: a exclusão não pode ser desfeita pelo painel. A integração perde o acesso na hora e, para voltar a usá-la, será preciso cadastrar uma nova aplicação e repassar as novas credenciais. Se a intenção é apenas pausar, prefira desativar.

Resumo