Pular para o conteúdo principal

Chave de API

Permite que a chave API acesse os endpoints para criar e buscar dados de usuários, listar catálogo de produtos, fazer um pedido e integração com Embed da loja.

Como gerar?​

Para gerar a chave é necessário acessar o painel Administrativo e seguir as etapas abaixo:"

  • No menu lateral clicar no item "Integração"
  • Acessar o item "Chave de API"
  • clicar em "Cadastrar"
  • Neste momento vai aparecer o modal abaixo para que seja colocar o nome e a especificação da filial.

Estrutura
Figura 1 - Modal de criação da Chave

  • Após clicar em "Criar"

Estrutura
Figura 1 - Modal com a Chave

Obs.: Por motivos de segurança a chave só pode ser copiada uma vez, sendo assim favor copiar e guardar em um local seguro.

Quem pode gerar?​

Apenas os usuários do painel administrativo tem acesso a chave de staging, porém a chave de produção só pode ser gerada por nossa equipe após as validações.

Onde usar?​

A chave de API pode ser usada nos seguintes locais:

Acesso das APIs​

  • Cadastro de usuários
  • Status de usuários e pontos
  • Catálogo de Produtos
  • Solicitação de Produto

Login automático​

Objetivo: Essa integração permite que o cliente tenha acesso a loja de produtos fazendo um login automático.

Onde usar: Essa integração pode ser usada como um acesso a loja dentro da plataforma do cliente sem que o usuário tenha que fazer login na nossa plataforma.

Exemplo: O "cliente A" já tem uma plataforma própria e com isso seu próprio login, o que o cliente precisa: dentro do seu app, site ou plataforma ele chama uma URL nossa e com isso o usuário precisa fazer um novo login e consegue visualizar nossa loja de produtos.