REST API

Complete REST API documentation. Use this for custom integrations or platforms without an official SDK.

Base URL

https://api.ondara.io/v1

Authentication

API Key

Include your API key in all requests using the X-API-Key header.

X-API-Key: YOUR_API_KEY

Access Token

After authentication, include the access token for player-specific requests.

Authorization: Bearer ACCESS_TOKEN

Quick Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Authenticate
curl -X POST https://api.ondara.io/v1/auth/anonymous \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "playerId": "pl_abc123",
  "accessToken": "eyJhbGciOiJSUzI1NiIs...",
  "refreshToken": "rt_xyz789...",
  "expiresIn": 3600
}

# Use the access token for subsequent requests
curl https://api.ondara.io/v1/players/pl_abc123/data \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."

Endpoints

Authentication

POST/auth/anonymousCreate anonymous session

POST/auth/email/registerRegister with email

POST/auth/email/loginLogin with email

POST/auth/googleLogin with Google token

POST/auth/refreshRefresh access token

POST/auth/logoutInvalidate session

Player Data

GET/players/{id}/dataGet all player data

GET/players/{id}/data/{key}Get specific key

PUT/players/{id}/data/{key}Set data value

DELETE/players/{id}/data/{key}Delete data key

PATCH/players/{id}/dataBatch update data

Cloud Save

GET/savesList all saves

GET/saves/{key}Get save data

PUT/saves/{key}Create or update save

DELETE/saves/{key}Delete save

Leaderboards

GET/leaderboards/{id}Get leaderboard entries

POST/leaderboards/{id}/scoresSubmit score

GET/leaderboards/{id}/playerGet player entry

Economy

GET/economy/currenciesGet player currencies

POST/economy/currencies/{id}/addAdd currency

POST/economy/currencies/{id}/subtractSubtract currency

GET/economy/inventoryGet player inventory

POST/economy/purchasePurchase item

Response Format

All responses are JSON. Successful responses include the data directly. Error responses follow this format:

1
2
3
4
5
6
7
{
  "error": {
    "code": "INVALID_TOKEN",
    "message": "The access token has expired",
    "details": {}
  }
}

Rate Limits

API requests are rate limited per project:

Free Plan100 requests/minute
Pro Plan1,000 requests/minute
EnterpriseCustom limits

Rate limit headers are included in all responses:X-RateLimit-Remaining

Documentation Error Codes

Quick Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Authenticate
curl -X POST https://api.ondara.io/v1/auth/anonymous \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "playerId": "pl_abc123",
  "accessToken": "eyJhbGciOiJSUzI1NiIs...",
  "refreshToken": "rt_xyz789...",
  "expiresIn": 3600
}

# Use the access token for subsequent requests
curl https://api.ondara.io/v1/players/pl_abc123/data \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."

Endpoints

Authentication

POST/auth/anonymousCreate anonymous session

POST/auth/email/registerRegister with email

POST/auth/email/loginLogin with email

POST/auth/googleLogin with Google token

POST/auth/refreshRefresh access token

POST/auth/logoutInvalidate session

Player Data

GET/players/{id}/dataGet all player data

GET/players/{id}/data/{key}Get specific key

PUT/players/{id}/data/{key}Set data value

DELETE/players/{id}/data/{key}Delete data key

PATCH/players/{id}/dataBatch update data

Cloud Save

GET/savesList all saves

GET/saves/{key}Get save data

PUT/saves/{key}Create or update save

DELETE/saves/{key}Delete save

Leaderboards

GET/leaderboards/{id}Get leaderboard entries

POST/leaderboards/{id}/scoresSubmit score

GET/leaderboards/{id}/playerGet player entry

Economy

GET/economy/currenciesGet player currencies

POST/economy/currencies/{id}/addAdd currency

POST/economy/currencies/{id}/subtractSubtract currency

GET/economy/inventoryGet player inventory

POST/economy/purchasePurchase item