OAuth 2.0

Token issuance and renewal for authenticating the Yep Platform REST API, plus a public healthcheck for availability validation.

client_credentials refresh_token Healthcheck

OAuth 2.0 flows

The /api2/oauth/token flows use Content-Type: application/x-www-form-urlencoded.

POST/api2/oauth/token

Get token with client credentials.

client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET
grant_type=client_credentials

POST/api2/oauth/token

Refresh token with refresh_token.

client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET
grant_type=refresh_token
refresh_token=YOUR_REFRESH_TOKEN

GET/api2/oauth/health

Public API healthcheck.

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

client_secret security

Store client_secret, access token and refresh token in a secure place. The client secret is displayed only once during integration creation in the admin panel.

Parameters

client_id Required

Public identifier of the integration generated in the admin panel.

client_secret Required

Secret shown only once upon integration creation. Treat it like a password.

grant_type Required

Accepts client_credentials to obtain a token or refresh_token to renew one.

refresh_token Conditional

Required when grant_type=refresh_token.