Passar para o conteúdo principal

Como solicitar a chave API?

Saiba o que é a chave API, para que ela serve e como solicitá-la de forma simples enviando um e-mail para a equipe de desenvolvedores.

Escrito por Lucas C.

O que você vai aprender neste artigo?

1. O que é a chave API e para que ela serve;
2. Como solicitar a sua chave API;

3. Pontos de atenção;

4. Como conhecer as APIs disponíveis.


A chave API é um recurso voltado para clientes que desejam integrar seus sistemas ou ferramentas externas com as APIs disponíveis na Mainô. Por meio dela, é possível autenticar requisições e garantir a segurança das integrações realizadas. A solicitação é simples e deve ser feita pelo usuário administrador do sistema ou pelo responsável legal da empresa. Neste artigo, você vai entender o que é essa chave e como solicitá-la.


1. O que é a chave API e para que ela serve

A chave API é um código único que identifica e autoriza a sua empresa a consumir as APIs disponíveis na Mainô. Ela garante a segurança das integrações, protegendo os dados e as operações da sua empresa. Sem essa chave, não é possível utilizar nenhuma das integrações via API.


2. Como solicitar a sua chave API

2.1 - O administrador da conta deve acessar o menu Configurações > Integrações e clicar na opção para solicitar a chave da API:
​

2.2 - Responder ao formulário e, ao enviar, aparecerá a confirmação de que a solicitação está em análise:
​

2.3 - O nosso time de produto/TI analisará a solicitação e:

  • Se aprovado, o administrador da conta receberá em até 1 dia útil um e-mail com um link para visualizar a chave uma única vez.

  • Se reprovado, o cliente receberá um e-mail informando o resultado. Nesse caso, é possível que o administrador da conta faça uma nova solicitação pelo mesmo caminho feito anteriormente. A opção de solicitação somente não aparecerá para o administrador se ele já possuir uma solicitação pendente.


3. Pontos de atenção:

  • A chave é exibida uma única vez com o link recebido por e-mail. Caso abra o link mais de uma vez, aparecerá somente a mensagem de que a chave já foi visualizada. Caso não tenha conseguido visualizar a chave da primeira vez, entre em contato com a gente pelo suporte.

  • Somente o administrador da conta poderá solicitar a chave. Para os demais usuários a opção não irá aparecer.


4. Para conhecer nossas APIs disponíveis:


Se tiver dúvidas, fale com a Mai pelo chat no sistema ou pelo número de WhatsApp (21) 2224-5777.

Respondeu à sua pergunta?