Referência da API REST

Os SDKs são clientes leves sobre esta API HTTPS + JSON, então qualquer engine, ferramenta ou servidor pode usá-la diretamente.

Comentários de código e nomes da API ficam em inglês para corresponder aos SDKs.

Nesta página

Noções básicas
Cabeçalhos
Respostas
Exemplo
Endpoints
Projeto
Autenticação de jogadores
Placares
Configuração remota
Salvamento na nuvem
Recompensas e carteira

Noções básicas#

URL base: https://majacloud.majanite.com/v1. HTTPS é obrigatório, exceto a partir de localhost. Os corpos das requisições são JSON com Content-Type: application/json.

Baixe a descrição OpenAPI 3.1 para gerar clientes ou importá-la no Postman ou no Insomnia.

Cabeçalhos#

Cabeçalho	Significado
`X-Project-ID`	ID do projeto, do painel (sempre).
`X-Client-Key`	Chave de cliente pública (sempre; pode ir nas builds com segurança).
`X-Secret-Key`	Chave secreta do servidor, no lugar da chave de cliente (somente de servidor para servidor).
`Authorization`	Bearer <access_token> para endpoints de jogador.
`X-Device-ID`	ID de instalação opcional (usado como rótulo do dispositivo do convidado).
`X-Majacloud-SDK`	Cliente e versão opcionais, ex.: unity/2.0.0.

Respostas#

Toda resposta é JSON com ok. Os erros também trazem um code estável, uma message, o request_id e, às vezes, details:

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 + ")");
}

GDScript

var top := await Majacloud.leaderboards.get_top("coins", 10)
if top.ok:
	for entry in top.value.entries:
		print("#%d %s %d" % [entry.rank, entry.player_name, entry.score])
elif top.is_retryable():
	# Network, timeout, 5xx or rate limit: try again later
	print("Retry in ", top.retry_after, " s")
else:
	push_warning("%s: %s (%s)" % [top.error, top.message, top.request_id])

JavaScript

const top = await mc.leaderboards.getTop('coins', { limit: 10 });
if (top.ok) {
  for (const entry of top.value.entries) {
    console.log(`#${entry.rank} ${entry.player_name} ${entry.score}`);
  }
} else if (top.error.retryable) {
  // Network, timeout, 5xx or rate limit: try again later
  console.log('Retry in', top.error.retryAfter, 's');
} else {
  console.warn(`${top.error.code}: ${top.error.message} (${top.error.requestId})`);
}

JSON

// Success
{ "ok": true, "entries": [ … ], "total": 42 }

// Error (HTTP 4xx/5xx)
{
  "ok": false,
  "error": {
    "code": "rate_limited",
    "message": "Project rate limit reached. Try again in a minute.",
    "request_id": "6f1c2a9e-…",
    "details": { "limit": 120, "window": "minute" }
  }
}

Exemplo#

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 '{}'

Endpoints#

Projeto#

GET/projectInformações do projeto, plano e chave pública da configuração remotaChave de cliente

Resposta 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
        }
    }
}

Autenticação de jogadores#

POST/auth/guestCria um jogador convidado e uma sessãoChave de cliente

Corpo

{
    "device_id": "optional installation id"
}

Resposta 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/refreshRotaciona o refresh token e obtém um novo token de acessoChave de cliente

Corpo

{
    "refresh_token": "…"
}

Resposta 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
    }
}

Erros

unauthorized (reason: invalid | expired | revoked | reused)

POST/auth/logoutRevoga a sessãoChave de cliente

Corpo

{
    "refresh_token": "optional"
}

Resposta 200

{
    "ok": true,
    "revoked": true
}

POST/auth/link/startInicia o login na web (vincula um convidado a e-mail ou Google)Token do jogador

Corpo

{
    "code_challenge": "base64url(sha256(verifier))",
    "code_challenge_method": "S256",
    "return_url": "optional, https on this host or an allowlisted scheme"
}

Resposta 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
}

GET/auth/link/statusConsulta o fluxo de loginChave de cliente

Query

flow_id — uuid
flow_token — …

Resposta 200

{
    "ok": true,
    "status": "pending | completed | consumed | expired",
    "exchange_code": "(only when completed)",
    "expires_at": "…"
}

POST/auth/link/exchangeTroca um fluxo concluído por uma sessãoChave de cliente

Corpo

{
    "flow_id": "uuid",
    "exchange_code": "…",
    "code_verifier": "the original verifier"
}

Resposta 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/meO jogador conectadoToken do jogador

Resposta 200

{
    "ok": true,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}

PATCH/players/meAltera o nome de exibiçãoToken do jogador

Corpo

{
    "display_name": "Nova"
}

Resposta 200

{
    "ok": true,
    "player": {
        "id": "c7a1…",
        "player_id": "player_3f9c…",
        "display_name": "Guest 4821",
        "auth_type": "guest",
        "email_verified": false
    }
}

GET/players/{player_id}Lê qualquer jogador (chave secreta)Chave secreta

Resposta 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
            }
        ]
    }
}

Placares#

POST/leaderboards/{slug}/scoresEnvia uma pontuaçãoToken do jogador

Corpo

{
    "score": 120
}

Resposta 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"
    }
}

Erros

validation (bounds)
rate_limited (cooldown)
plan_limit (entry cap)

GET/leaderboards/{slug}/entriesPrimeiras posiçõesChave de cliente

Query

limit — 1-100 (default 10)
offset — 0+
period — current | previous

Resposta 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}/meMinha posição e pontuaçãoToken do jogador

Query

period — current | previous

Resposta 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-meEntradas ao redor da minha posiçãoToken do jogador

Query

radius — 1-25 (default 3)

Resposta 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
}

Configuração remota#

GET/configConfiguração publicada, assinada com RSA; envie If-None-Match para receber 304Chave de cliente

Resposta 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"
        }
    ]
}

Salvamento na nuvem#

GET/cloudLista as chaves salvasToken do jogador

Resposta 200

{
    "ok": true,
    "keys": [
        {
            "key": "progress",
            "revision": 3,
            "size_bytes": 180,
            "updated_at": "…"
        }
    ],
    "total_bytes": 180
}

GET/cloud/{key}Carrega um documentoToken do jogador

Resposta 200

{
    "ok": true,
    "key": "progress",
    "data": {
        "level": 3
    },
    "revision": 3,
    "size_bytes": 180,
    "updated_at": "…"
}

PUT/cloud/{key}Salva um documento (revisão esperada opcional)Token do jogador

Corpo

{
    "data": {
        "level": 4
    },
    "revision": "optional: expected current revision (0 = create only)"
}

Resposta 200

{
    "ok": true,
    "key": "progress",
    "revision": 4,
    "size_bytes": 190,
    "updated_at": "…",
    "created": false
}

Erros

revision_mismatch (details.current_revision)
plan_limit (storage)

DELETE/cloud/{key}Exclui um documentoToken do jogador

Resposta 200

{
    "ok": true,
    "key": "progress",
    "deleted": true
}

Recompensas e carteira#

GET/rewardsRecompensas ativas (com indicação de resgate disponível quando há token de jogador)Chave de cliente

Resposta 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/claimResgata uma recompensaToken do jogador

Corpo

{
    "reward_key": "daily_coins"
}

Resposta 200

{
    "ok": true,
    "accepted": true,
    "reward_key": "daily_coins",
    "amount": 50,
    "currency": "coins",
    "balance": 150,
    "next_claim_at": "2026-10-10T00:00:00Z"
}

Erros

conflict (already claimed; details.next_claim_at)

GET/walletSaldos da carteiraToken do jogador

Resposta 200

{
    "ok": true,
    "wallets": [
        {
            "currency": "coins",
            "balance": 150,
            "updated_at": "…"
        }
    ]
}