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

Atalho

Coleção Postman pronta para importar

Todas as requisições da API REST Yep com headers, query params, bodies de exemplo e scripts que capturam token, order_id e demais IDs entre as chamadas. Compatível com Postman, Insomnia e clientes que aceitam schema v2.1.0.

Auth Catálogo Pedidos Clientes Multi-estoque

Baixar coleçãoPostman v2.1.0 · .json

Pré-requisitos

O que você precisa ter em mãos antes de começar:

Integração cadastrada no administrativo com client_id e client_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_credentials

2. 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.

Próximos passos

OAuth 2.0 completoRefresh token e ciclo de vida do token. Endpoints de produtosCRUD, vínculo e imagens. Boas práticasSegurança e semântica de respostas. NovidadesÚltimas evoluções da API.