Visão Geral
Esta API suporta dois métodos de autenticação:OAuth 2.0 com JWT (Recomendado)
A autenticação OAuth 2.0 utiliza o fluxo Client Credentials. Você recebe umclient_id e um client_secret que são usados para obter um token JWT (access token).
Como obter suas credenciais OAuth
Entre em contato com o suporte Pontaltech para solicitar suas credenciais OAuth. Você receberá:- client_id: identificador único da sua aplicação
- client_secret: chave secreta para autenticação
Como obter o token
Faça uma requisiçãoPOST para o endpoint de token:
A autenticação do client é feita via HTTP Basic Auth no header (flag -u), onde o client_id é o usuário e o client_secret é a senha.
Resposta do token
Usando o token nas requisições
Inclua o token no headerAuthorization:
Exemplo completo
Expiração e renovação
- O token expira após 1 hora (3600 segundos).
- Não existe refresh token neste fluxo. Quando o token expirar, solicite um novo com as mesmas credenciais.
- Boas práticas: armazene o token em cache e renove antes de expirar (ex: a cada 50 minutos).
Erros de autenticação OAuth
Basic Auth (Legado)
A autenticação Basic Auth continua funcionando para integrações existentes.Como funciona
A autenticação consiste em usar:- slug como usuário
- apiKey como senha
:) e codificados em Base64, no formato:
Exemplo
Se o slug formeusite e o apiKey for abc123, o valor codificado será:
Como testar no Postman ou Insomnia
OAuth 2.0
- Vá até a aba Authorization
- Selecione o tipo:
OAuth 2.0 - Configure:
- Grant Type:
Client Credentials - Access Token URL:
https://auth-sms.pontaltech.com.br/oauth2/token - Client ID: seu
client_id - Client Secret: seu
client_secret - Scope:
pontaltech-api/sms - Client Authentication:
Send as Basic Auth header
- Grant Type:
- Clique em Get New Access Token
Basic Auth
- Vá até a aba Authorization
- Selecione o tipo:
Basic Auth - Preencha:
- Username:
slug - Password:
apiKey
- Username:
- A ferramenta irá gerar automaticamente o header
Authorizationcom o valorBasic <base64(slug:apiKey)>
Observações
- Todas as rotas protegidas exigem um dos métodos de autenticação acima.
- Para novas integrações, utilize OAuth 2.0 (JWT) — mais seguro e com controle granular de escopos.
- Não compartilhe suas credenciais (
apiKey,client_idouclient_secret). - Credenciais inválidas retornarão erro
401 (Unauthorized). - Para solicitar credenciais OAuth, entre em contato com o suporte Pontaltech.