Passar para o conteúdo principal

Autenticação para API

Saiba como autenticar suas requisições na API da Mainô usando o protocolo OAuth2.

Escrito por Atendimento da Mainô

O que você vai aprender neste artigo?

1. O que é a autenticação OAuth2 e quando ela é necessária;
2. Quais são os pré-requisitos para autenticar na API;
3. Como realizar a autenticação e obter o token de acesso.

A API da Mainô utiliza o protocolo OAuth2 para garantir que apenas sistemas autorizados consigam acessar e manipular dados. Esse processo de autenticação é obrigatório para qualquer integração via API — seja para emitir notas fiscais, movimentar estoque, registrar vendas ou qualquer outra operação. Antes de começar, você vai precisar de um Application UID, que é fornecido pelo time da Mainô, e de credenciais de usuário válidas no sistema. Caso ainda não tenha essas informações, entre em contato com o suporte antes de prosseguir.


1. O que é a autenticação OAuth2 e quando ela é necessária

OAuth2 é o protocolo padrão de autorização utilizado pela API da Mainô. Ele funciona da seguinte forma: ao enviar suas credenciais para o endpoint de autenticação, o sistema retorna um token de acesso temporário. Esse token deve ser incluído no cabeçalho de todas as requisições subsequentes. Sem ele, as chamadas à API serão rejeitadas.


2. Quais são os pré-requisitos para autenticar na API

Para realizar a autenticação, você vai precisar dos seguintes itens:
• Application UID: identificador único da sua aplicação, fornecido pelo time da Mainô;
• Credenciais de usuário: login e senha de um usuário válido cadastrado no sistema.

Para obter o Application UID, é necessário que o administrador da conta faça a solicitação, preenchendo o formulário abaixo: https://docs.google.com/forms/d/e/1FAIpQLSfCxaLtkkijCogDSViE5S8tFJoiwn5hP-pSlK6Sf7R2fakNvQ/viewform

Após o preenchimento, nosso time retorna com a chave por e-mail, com prazo de até 1 dia útil.


3. Como realizar a autenticação e obter o token de acesso

A autenticação é feita por meio de uma requisição ao endpoint de Authentication da API. A documentação completa com os parâmetros, formato da requisição e exemplos de resposta está disponível no link abaixo:

Após enviar a requisição com as credenciais corretas, o sistema retorna um token de acesso. Esse token deve ser incluído no cabeçalho Authorization de todas as chamadas seguintes à API, no formato Bearer [token].


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

Respondeu à sua pergunta?