Introduction - Yuko Documentation

The Yuko API is organized around REST. Our API has predictable, resource-oriented URLs and uses standard HTTP response codes to indicate success or failure. All request and response bodies are JSON.

Base URL

https://api.yukoapp.com/api/v1/public

Request format

All requests must include the following headers:

Header	Value
`Authorization`	`Bearer YOUR_API_KEY`
`Accept`	`application/json`
`Content-Type`	`application/json` (for `POST` requests with a body)

Always send Accept: application/json. Without it, a few framework-level errors (such as rate limiting or an unknown URL) may come back as HTML instead of JSON.

Response format

All responses return JSON. Successful responses wrap the result in a data key; list endpoints also return meta.pagination. Error responses return an error object with a machine-readable code and a human-readable message:

{
  "error": {
    "code": "insufficient_scope",
    "message": "Your API token does not have the required 'rewards' scope for this action"
  }
}

Authentication and scopes

Authenticate with a REST API key as a Bearer token. Each key is limited to the scopes the merchant chose, written as read:<scope> or write:<scope>. See Authentication and Scopes.