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 um client_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ção POST 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 header Authorization:

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
Esses dois valores são concatenados com dois-pontos (:) e codificados em Base64, no formato:
Você deve então usar o cabeçalho HTTP:

Exemplo

Se o slug for meusite e o apiKey for abc123, o valor codificado será:
O que resultará em algo como:
Então o header será:

Como testar no Postman ou Insomnia

OAuth 2.0

  1. Vá até a aba Authorization
  2. Selecione o tipo: OAuth 2.0
  3. 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
  4. Clique em Get New Access Token

Basic Auth

  1. Vá até a aba Authorization
  2. Selecione o tipo: Basic Auth
  3. Preencha:
    • Username: slug
    • Password: apiKey
  4. A ferramenta irá gerar automaticamente o header Authorization com o valor Basic <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_id ou client_secret).
  • Credenciais inválidas retornarão erro 401 (Unauthorized).
  • Para solicitar credenciais OAuth, entre em contato com o suporte Pontaltech.