OAuth 2.0

Obtenção e renovação de tokens para autenticação da API REST da Plataforma Yep, com healthcheck para validação de disponibilidade.

client_credentials refresh_token Healthcheck

Fluxos OAuth 2.0

Os fluxos do endpoint /api2/oauth/token usam Content-Type: application/x-www-form-urlencoded.

POST/api2/oauth/token

Obter token com client credentials.

client_id=SEU_CLIENT_ID
client_secret=SEU_CLIENT_SECRET
grant_type=client_credentials

POST/api2/oauth/token

Renovar token com refresh token.

client_id=SEU_CLIENT_ID
client_secret=SEU_CLIENT_SECRET
grant_type=refresh_token
refresh_token=SEU_REFRESH_TOKEN

GET/api2/oauth/health

Healthcheck público da API.

{
  "status": "ok",
  "message": "API Rest da Plataforma Yep! Ativa"
}

Segurança do client_secret

Armazene client_secret, access token e refresh token em local seguro. O segredo de cliente é exibido uma única vez na criação da integração no admin.

Parâmetros

client_id Obrigatório

Identificador público da integração gerado no administrativo.

client_secret Obrigatório

Segredo exibido uma única vez na criação da integração. Trate como senha.

grant_type Obrigatório

Aceita client_credentials para obter token ou refresh_token para renovar.

refresh_token Condicional

Obrigatório quando grant_type=refresh_token.