- Um usuário de API é o login que um sistema usa para se conectar à sua loja pela API.
- Ele serve para integrar a loja com outros sistemas, como um ERP.
- Você cria em Usuários "Usuários API". A API tem uma taxa mensal fixa, e o valor atual aparece em "Condição de uso", na própria tela.
Antes de começar
- Acesso ao menu Usuários do painel.
- Leia a "Condição de uso" na tela "Usuários API". A cobrança é mensal e renovada automaticamente, feita por ciclos fechados: o valor do mês é cobrado inteiro, mesmo se você cancelar antes do fim do ciclo.
- O e-mail do responsável pela integração.
- Se for usar webhooks, os endereços do seu sistema que vão receber os avisos.
Etapa 1: abra a tela "Usuários API"
No menu lateral, clique em "Usuários" e depois no botão "Usuários API". A tela lista os usuários já criados, com as colunas Usuário, Senha, WebHook, Status, Adicionado, Último Acesso e Ação.
Etapa 2: clique em "Adicionar"
No topo da tela, clique em "Adicionar" para abrir o formulário do novo usuário.
Etapa 3: preencha os dados do usuário
- "Status": liga ou desliga o usuário.
- "Email": o e-mail do responsável.
- "Usuário": o nome de usuário. O campo já vem com o prefixo da loja, e há um botão para copiar.
- "Senha": clique no botão de gerar para criar uma senha. Há um botão para copiar.
Etapa 4: informe os webhooks, se quiser
Os webhooks são endereços do seu sistema que recebem um aviso quando algo acontece na loja. Preencha o que você usar:
- "WebHook Pedidos"
- "WebHook Produtos"
- "WebHook Carrinho Abandonado"
- "WebHook Clientes"
Etapa 5: salve e copie o acesso
Clique em "Salvar", no topo da tela. Depois, copie o usuário e a senha para usar na API. Na lista, a coluna "Senha" tem um ícone de copiar.
Etapa 6: abra a documentação
Clique em "Documentação", no topo da tela de lista ou do formulário. Ela abre a documentação da API da Irroba em uma nova página.
Perguntas frequentes
A API tem custo?
Sim. Ela tem uma taxa mensal fixa. O valor e as regras de cobrança aparecem em "Condição de uso", na tela "Usuários API".
Como gero a senha?
No formulário, clique no botão de gerar ao lado do campo "Senha".
Onde fica a documentação da API?
No botão "Documentação", no topo da tela "Usuários API" e do formulário.
Como edito um usuário?
Na lista, clique em "Editar" na coluna "Ação".
Como sei se o usuário já foi usado?
Veja a coluna "Último Acesso". Quando o usuário nunca foi usado, ela mostra "Nunca Acessado".
Erros comuns
Não consigo copiar a senha depois de salvar
Use o ícone de copiar da coluna "Senha", na lista, ou o botão de copiar do formulário.
O sistema não consegue se conectar com o usuário criado
Confira se o "Status" do usuário está ligado e se o usuário e a senha foram copiados exatamente como aparecem.