Getting started

Step-by-step to generate an OAuth token and make your first authenticated call to the Yep Platform REST API.

OAuth 2.0 Bearer Token 5 minutes

Shortcut

Postman collection ready to import

All Yep REST API requests with headers, query params, example bodies and scripts that capture token, order_id and the other IDs across requests. Works with Postman, Insomnia and any client that supports schema v2.1.0.

Auth Catalog Orders Customers Multi-inventory

Download collectionPostman v2.1.0 · .json

Prerequisites

What you need before starting:

Integration registered in the admin panel with client_id and client_secret.
Access to the OAuth endpoint (/api2/oauth/token).
HTTP client capable of sending JSON and the Authorization: Bearer <token> header.

Minimum flow to start

Three calls cover the full cycle: obtain token, validate API and send the first authenticated request.

1. Get token via client credentials

POST/api2/oauth/token

Access token issuance via client_credentials. Send as application/x-www-form-urlencoded.

client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET
grant_type=client_credentials

2. Validate availability

GET/api2/oauth/health

Public API healthcheck. No authentication required.

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

3. First authenticated call

Send the required headers

After getting the token, include Authorization: Bearer <token> and Content-Type: application/json on all protected endpoints.

Next steps

Full OAuth 2.0Refresh token and token lifecycle. Product endpointsCRUD, linking and images. Best practicesSecurity and response semantics. What's newLatest API evolutions.