MAJACLOUD

Справочник REST API

SDK — это тонкие клиенты поверх этого API на HTTPS + JSON, поэтому любой движок, инструмент или сервер может работать с ним напрямую.

Комментарии в коде и имена API оставлены на английском, чтобы совпадать с SDK.

На этой странице

Основы#

Базовый URL: https://majacloud.majanite.com/v1. HTTPS обязателен везде, кроме localhost. Тела запросов передаются в JSON с Content-Type: application/json.

Скачайте описание OpenAPI 3.1, чтобы сгенерировать клиенты или импортировать его в Postman или Insomnia.

Заголовки#

ЗаголовокЗначение
X-Project-IDID проекта из панели управления (всегда).
X-Client-KeyПубличный клиентский ключ (всегда; его можно включать в сборки).
X-Secret-KeyСекретный ключ сервера вместо клиентского ключа (только между серверами).
AuthorizationBearer <access_token> для эндпоинтов игрока.
X-Device-IDНеобязательный ID установки (используется как метка устройства гостя).
X-Majacloud-SDKНеобязательно: клиент и версия, например unity/2.0.0.

Ответы#

Каждый ответ — JSON с полем ok. Ошибки также содержат постоянный code, message, request_id и иногда details:

C#
var top = await Majacloud.Leaderboards.GetTopAsync("coins", 10);
if (top.Ok)
{
    foreach (var entry in top.Value.Entries)
        Debug.Log($"#{entry.Rank} {entry.PlayerName} {entry.Score}");
}
else if (top.Error.IsRetryable)
{
    // Network, timeout, 5xx or rate limit: try again later
    Debug.Log("Retry in " + top.Error.RetryAfterSeconds + " s");
}
else
{
    Debug.LogWarning(top.Error.Code + ": " + top.Error.Message + " (" + top.Error.RequestId + ")");
}

Пример#

bash
export PROJECT_ID="<project id>" CLIENT_KEY="pk_live_…"

curl https://majacloud.majanite.com/v1/project -H "X-Project-ID: $PROJECT_ID" -H "X-Client-Key: $CLIENT_KEY"

curl -X POST https://majacloud.majanite.com/v1/auth/guest -H "X-Project-ID: $PROJECT_ID" -H "X-Client-Key: $CLIENT_KEY" \
  -H "Content-Type: application/json" -d '{}'

Эндпоинты#

Проект#

GET/projectСведения о проекте, тариф и публичный ключ удалённой конфигурацииКлиентский ключ
Ответ 200
{
    "ok": true,
    "project": {
        "id": "8f3c…",
        "name": "Space Runner",
        "plan": "free",
        "config_version": 12,
        "config_public_key_xml": "<RSAKeyValue>…</RSAKeyValue>",
        "config_public_key_pem": "-----BEGIN PUBLIC KEY-----\n…\n-----END PUBLIC KEY-----\n",
        "services": {
            "player_auth": true,
            "leaderboards": true,
            "remote_config": true,
            "cloud_save": true,
            "rewards": true
        }
    }
}

Авторизация игроков#

POST/auth/guestСоздать гостя и сессиюКлиентский ключ
Тело
{
    "device_id": "optional installation id"
}
Ответ 201
{
    "ok": true,
    "auth_method": "guest",
    "access_token": "eyJ2IjoyLCJ0IjoiYWNjZXNz…",
    "token_type": "Bearer",
    "expires_in": 3600,
    "refresh_token": "2d0f…",
    "refresh_expires_in": 2592000,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}
POST/auth/refreshСменить токен обновления и получить новый токен доступаКлиентский ключ
Тело
{
    "refresh_token": "…"
}
Ответ 200
{
    "ok": true,
    "auth_method": "guest",
    "access_token": "eyJ2IjoyLCJ0IjoiYWNjZXNz…",
    "token_type": "Bearer",
    "expires_in": 3600,
    "refresh_token": "2d0f…",
    "refresh_expires_in": 2592000,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}
Ошибки
  • unauthorized (reason: invalid | expired | revoked | reused)
POST/auth/logoutОтозвать сессиюКлиентский ключ
Тело
{
    "refresh_token": "optional"
}
Ответ 200
{
    "ok": true,
    "revoked": true
}
POST/auth/link/startНачать веб-вход (привязать гостя к email или Google)Токен игрока
Тело
{
    "code_challenge": "base64url(sha256(verifier))",
    "code_challenge_method": "S256",
    "return_url": "optional, https on this host or an allowlisted scheme"
}
Ответ 201
{
    "ok": true,
    "flow_id": "uuid",
    "flow_token": "…",
    "auth_url": "https://majacloud.majanite.com/player-auth.php?flow_id=…&flow_token=…",
    "expires_at": "2026-10-09T08:27:00Z",
    "poll_interval_seconds": 3
}
POST/auth/link/exchangeОбменять завершённый процесс на сессиюКлиентский ключ
Тело
{
    "flow_id": "uuid",
    "exchange_code": "…",
    "code_verifier": "the original verifier"
}
Ответ 200
{
    "ok": true,
    "auth_method": "guest",
    "access_token": "eyJ2IjoyLCJ0IjoiYWNjZXNz…",
    "token_type": "Bearer",
    "expires_in": 3600,
    "refresh_token": "2d0f…",
    "refresh_expires_in": 2592000,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    },
    "merged_guest": true
}
GET/players/meТекущий вошедший игрокТокен игрока
Ответ 200
{
    "ok": true,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}
PATCH/players/meИзменить отображаемое имяТокен игрока
Тело
{
    "display_name": "Nova"
}
Ответ 200
{
    "ok": true,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}
GET/players/{player_id}Данные любого игрока (секретный ключ)Секретный ключ
Ответ 200
{
    "ok": true,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false,
        "email": "nova@example.com",
        "wallets": [
            {
                "currency": "coins",
                "balance": 150
            }
        ]
    }
}

Таблицы лидеров#

POST/leaderboards/{slug}/scoresОтправить результатТокен игрока
Тело
{
    "score": 120
}
Ответ 200
{
    "ok": true,
    "accepted": true,
    "entry": {
        "rank": 1,
        "player_id": "player_3f9c…",
        "player_name": "Nova",
        "score": 9840,
        "score_updated_at": "2026-10-09T08:12:00Z",
        "is_me": false
    },
    "period": {
        "key": "2026-W41",
        "ends_at": "2026-10-12T00:00:00Z"
    }
}
Ошибки
  • validation (bounds)
  • rate_limited (cooldown)
  • plan_limit (entry cap)
GET/leaderboards/{slug}/entriesЛучшие записиКлиентский ключ
Параметры запроса
  • limit — 1-100 (default 10)
  • offset — 0+
  • period — current | previous
Ответ 200
{
    "ok": true,
    "leaderboard": {
        "slug": "coins",
        "name": "Coins",
        "sort_type": "DESC",
        "score_mode": "BEST",
        "reset_rule": "WEEKLY"
    },
    "period": {
        "key": "2026-W41",
        "ends_at": "2026-10-12T00:00:00Z"
    },
    "entries": [
        {
            "rank": 1,
            "player_id": "player_3f9c…",
            "player_name": "Nova",
            "score": 9840,
            "score_updated_at": "2026-10-09T08:12:00Z",
            "is_me": false
        }
    ],
    "total": 42,
    "limit": 10,
    "offset": 0,
    "max_entries": 10
}
GET/leaderboards/{slug}/meМоё место и результатТокен игрока
Параметры запроса
  • period — current | previous
Ответ 200
{
    "ok": true,
    "entry": {
        "rank": 1,
        "player_id": "player_3f9c…",
        "player_name": "Nova",
        "score": 9840,
        "score_updated_at": "2026-10-09T08:12:00Z",
        "is_me": false
    },
    "total": 42
}
GET/leaderboards/{slug}/around-meЗаписи рядом с моим местомТокен игрока
Параметры запроса
  • radius — 1-25 (default 3)
Ответ 200
{
    "ok": true,
    "entries": [
        {
            "rank": 1,
            "player_id": "player_3f9c…",
            "player_name": "Nova",
            "score": 9840,
            "score_updated_at": "2026-10-09T08:12:00Z",
            "is_me": false
        }
    ],
    "me": {
        "rank": 1,
        "player_id": "player_3f9c…",
        "player_name": "Nova",
        "score": 9840,
        "score_updated_at": "2026-10-09T08:12:00Z",
        "is_me": false
    },
    "total": 42
}

Удалённая конфигурация#

GET/configАктуальная конфигурация с RSA-подписью; передайте If-None-Match, чтобы получить 304Клиентский ключ
Ответ 200
{
    "ok": true,
    "project_id": "8f3c…",
    "version": 12,
    "checksum": "sha256 of data",
    "data": "base64url(JSON payload)",
    "signature": "base64 RSA-SHA256 over data",
    "signature_algorithm": "rsa-sha256",
    "signing_key_id": "config-v1",
    "configs": [
        {
            "key": "enemy_damage",
            "type": "number",
            "value": "25"
        }
    ]
}

Облачные сохранения#

GET/cloudСписок сохранённых ключейТокен игрока
Ответ 200
{
    "ok": true,
    "keys": [
        {
            "key": "progress",
            "revision": 3,
            "size_bytes": 180,
            "updated_at": "…"
        }
    ],
    "total_bytes": 180
}
GET/cloud/{key}Загрузить документТокен игрока
Ответ 200
{
    "ok": true,
    "key": "progress",
    "data": {
        "level": 3
    },
    "revision": 3,
    "size_bytes": 180,
    "updated_at": "…"
}
PUT/cloud/{key}Сохранить документ (с необязательной ожидаемой ревизией)Токен игрока
Тело
{
    "data": {
        "level": 4
    },
    "revision": "optional: expected current revision (0 = create only)"
}
Ответ 200
{
    "ok": true,
    "key": "progress",
    "revision": 4,
    "size_bytes": 190,
    "updated_at": "…",
    "created": false
}
Ошибки
  • revision_mismatch (details.current_revision)
  • plan_limit (storage)
DELETE/cloud/{key}Удалить документТокен игрока
Ответ 200
{
    "ok": true,
    "key": "progress",
    "deleted": true
}

Награды и кошелёк#

GET/rewardsАктивные награды (с флагами claimable при наличии токена игрока)Клиентский ключ
Ответ 200
{
    "ok": true,
    "rewards": [
        {
            "reward_key": "daily_coins",
            "name": "Daily coins",
            "amount": 50,
            "currency": "coins",
            "cooldown": "daily",
            "claimable": true,
            "next_claim_at": null
        }
    ]
}
POST/rewards/claimПолучить наградуТокен игрока
Тело
{
    "reward_key": "daily_coins"
}
Ответ 200
{
    "ok": true,
    "accepted": true,
    "reward_key": "daily_coins",
    "amount": 50,
    "currency": "coins",
    "balance": 150,
    "next_claim_at": "2026-10-10T00:00:00Z"
}
Ошибки
  • conflict (already claimed; details.next_claim_at)
GET/walletБалансы кошелькаТокен игрока
Ответ 200
{
    "ok": true,
    "wallets": [
        {
            "currency": "coins",
            "balance": 150,
            "updated_at": "…"
        }
    ]
}

Поиск по названиям страниц, заголовкам и тексту.

↑↓ навигация ↵ открыть Esc закрыть