A credencial é a chave que permite outro sistema acessar os dados da sua loja pela API INK. Sem ela, nenhuma integração funciona. Neste artigo você vê como criar, como escolher o que ela pode fazer, como cuidar dela e como cortar o acesso quando precisar.
A API INK está disponível apenas no plano Inkrível. Em outro plano, o painel mostra a opção de upgrade em vez da criação de credencial.
Como criar
-
No seu painel, clique em Credenciais de API.
-
Clique em criar uma nova credencial e dê um nome que diga para que ela serve, por exemplo "sistema de gestão" ou "planilha de vendas". Esse nome é só para você se organizar depois.
-
Marque o que a credencial pode fazer. As permissões são separadas por assunto e por tipo de acesso: consultar ou alterar. Você marca, por exemplo, consultar pedidos e alterar produtos, e deixa o resto de fora.
-
Salve. A INK mostra o identificador e o código secreto da credencial.
-
Copie o código secreto e guarde num lugar seguro. Ele aparece uma única vez. Se você fechar a tela sem copiar, não tem como recuperar, só criar outra credencial.
-
Entregue o identificador e o código secreto para quem vai montar a conexão, junto com o endereço da documentação, developers.reserva.ink.
O que dá para fazer depois de criar
Na mesma tela ficam as credenciais que você já criou. Ali você:
-
Vê a lista, com o nome e as permissões de cada uma.
-
Renomeia, se o nome não estiver mais dizendo o que é.
-
Revoga, quando quiser cortar o acesso.
Revogar tem efeito imediato: as chamadas feitas com aquela credencial passam a ser recusadas na hora. Use isso quando desligar uma integração, trocar de fornecedor ou suspeitar que o código secreto vazou.
Não existe como ver o código secreto de novo depois da criação, nem para você. Se ele foi perdido, o caminho é criar uma credencial nova e revogar a antiga.
Segurança: cinco cuidados que evitam problema
Marque só o que a integração precisa. Uma credencial que só lê pedidos não consegue apagar produto, mesmo se o código do outro lado tiver erro ou for usado por outra pessoa. É a proteção mais simples e a mais eficiente.
Uma credencial por integração. Se a mesma chave alimenta o sistema de gestão, a planilha e a automação, você não consegue desligar uma sem derrubar as outras três. Separando, dá para revogar uma coisa por vez e você também descobre qual integração está causando problema.
Comece com uma credencial só de consulta. Ao montar ou testar uma conexão, crie primeiro uma credencial sem permissão de alteração. Confira se o outro lado está lendo os dados certos e só depois gere uma com permissão de alterar.
Não coloque a credencial no site nem no aplicativo. Ela só deve existir no servidor ou na ferramenta que faz a conexão. Se ela aparecer no código do site, qualquer visitante consegue ler.
Revogue quando alguém sai. Se quem montou a integração era um fornecedor ou alguém do time que saiu, revogue e crie outra credencial. Ela vale para a loja, não para a pessoa.
O que mais é bom saber
-
A credencial só enxerga e altera dados da sua própria loja.
-
Existe um limite de chamadas por minuto. Se o outro sistema passar do limite, as chamadas são recusadas até o minuto seguinte. O número está no portal de documentação.
-
Em toda operação que altera dados, a API exige uma identificação da chamada, chamada chave de idempotência. Ela evita que a mesma coisa seja criada duas vezes se a chamada for repetida. Quem monta a conexão cuida disso.
-
Se a sua loja sair do plano Inkrível, as credenciais são revogadas e as integrações param de funcionar.