Começando
Passo a passo para gerar token OAuth e realizar a primeira chamada autenticada na API REST da Plataforma Yep.
OAuth 2.0
Bearer Token
5 minutos
Pré-requisitos
O que você precisa ter em mãos antes de começar:
- Integração cadastrada no administrativo com
client_ideclient_secret. - Acesso ao endpoint de OAuth (
/api2/oauth/token). - Client HTTP capaz de enviar JSON e cabeçalho
Authorization: Bearer <token>.
Fluxo mínimo para começar
Três chamadas resolvem o ciclo completo: obter token, validar a API e enviar a primeira requisição autenticada.
1. Obter token via client credentials
POST/api2/oauth/token
Geração de access token via client_credentials. Envie como application/x-www-form-urlencoded.
client_id=SEU_CLIENT_ID
client_secret=SEU_CLIENT_SECRET
grant_type=client_credentials2. Validar disponibilidade
GET/api2/oauth/health
Healthcheck da API. Não requer autenticação.
{
"status": "ok",
"message": "API Rest da Plataforma Yep! Ativa"
}3. Primeira chamada autenticada
Envie os cabeçalhos obrigatórios
Após obter o token, inclua Authorization: Bearer <token> e Content-Type: application/json em todos os endpoints protegidos.