Logo da Plataforma Yep
API REST · Plataforma Yep Documentação técnica para integrações homologadas

Autenticação

Como autenticar chamadas protegidas da API REST da Plataforma Yep com Bearer Token e boas práticas para preservação de credenciais.

Bearer Token OAuth 2.0 Segurança

Autenticação nas rotas protegidas

As rotas protegidas exigem cabeçalho Authorization: Bearer <token> e corpo em application/json quando aplicável.

Padrão recomendado

Obtenha o token via OAuth, armazene em ambiente seguro e renove utilizando refresh_token quando necessário. Veja o fluxo completo em OAuth 2.0.

Cabeçalhos obrigatórios

Inclua estes cabeçalhos em toda requisição autenticada para endpoints protegidos:

Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type: application/json
Authorization Obrigatório
Prefixo Bearer seguido do access token obtido no fluxo OAuth.
Content-Type Obrigatório
Use application/json para a maioria dos endpoints e application/x-www-form-urlencoded para /api2/oauth/token.

Checklist de boas práticas

  • Armazene tokens em cofres de segredos ou variáveis de ambiente seguras.
  • Nunca exponha tokens em logs, prints ou ferramentas de monitoramento sem mascaramento.
  • Renove o token antes do vencimento utilizando refresh_token.
  • Trate respostas 401 solicitando novo token automaticamente.