SDK Web

Um único arquivo JavaScript, sem dependências, para jogos HTML5, sites e servidores Node.js.

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

Nesta página

Requisitos#

  • Versões atuais do Chrome, Edge, Firefox e Safari (desktop e mobile), ou Node.js 18+.
  • A página precisa ser servida via HTTPS (ou localhost): a API exige HTTPS, e o Web Crypto, usado para verificar a configuração remota, só existe em páginas seguras.

Instalação#

Carregue-o do seu servidor MAJACLOUD, que o serve com cabeçalhos CORS:

HTML
<script src="https://majacloud.majanite.com/downloads/majacloud-web-1.0.0.js"></script>
<script type="module">
  const mc = Majacloud.createClient({ baseUrl: 'https://majacloud.majanite.com', projectId: '<project id>', clientKey: 'pk_live_…' });
</script>

Ou copie majacloud.js para o seu projeto:

JavaScript
// Bundlers (Vite, webpack…): copy majacloud.js into your project
import Majacloud from './majacloud.js';

// Node.js 18+
const Majacloud = require('./majacloud.js');

Crie um cliente#

Apenas baseUrl, projectId e clientKey são obrigatórios.

JavaScript
const mc = Majacloud.createClient({
  baseUrl: 'https://majacloud.majanite.com',      // your MAJACLOUD address
  projectId: '<project id>',
  clientKey: 'pk_live_…',     // public, safe in the browser
  configPublicKey: PEM,       // optional: pins Remote Config verification
  storage: 'memory',          // optional: 'memory' or { get, set, remove }; default localStorage
  timeoutMs: 15000,           // optional
  maxRetries: 2,              // optional
});

Resultados#

Toda chamada resolve para { ok: true, value } ou { ok: false, error } e nunca é rejeitada. value é o corpo da resposta REST sem ok, com os mesmos campos em snake_case da referência REST.

error tem code, message, status, requestId, retryAfter, details e retryable.

Eventos#

Inscreva-se com on(); ele retorna uma função que cancela a inscrição.

JavaScript
const stop = mc.auth.on('playerChanged', (player) => {
  document.querySelector('#name').textContent = player ? player.display_name : '';
});
mc.auth.on('sessionExpired', () => showSignIn());
mc.remoteConfig.on('updated', () => applyBalance());

stop(); // every on() returns an unsubscribe function

Um placar no seu site#

Ler um placar não exige login, então um site pode mostrar seus melhores jogadores usando apenas a chave de cliente pública:

HTML
<ol id="top-players"></ol>
<script src="https://majacloud.majanite.com/downloads/majacloud-web-1.0.0.js"></script>
<script>
  const mc = Majacloud.createClient({ baseUrl: 'https://majacloud.majanite.com', projectId: '<project id>', clientKey: 'pk_live_…' });
  mc.leaderboards.getTop('coins', { limit: 10 }).then((top) => {
    if (!top.ok) return;
    document.getElementById('top-players').innerHTML = '';
    for (const entry of top.value.entries) {
      const li = document.createElement('li');
      li.textContent = `${entry.player_name} — ${entry.score}`;
      document.getElementById('top-players').append(li);
    }
  });
</script>

Várias abas#

A sessão fica em localStorage e é compartilhada por todas as abas do seu site. Os refresh tokens são rotacionados, então as abas se revezam na renovação (Web Locks) e aproveitam os novos tokens umas das outras: os jogadores nunca são desconectados por abrir uma segunda aba.

No servidor, com a chave secreta#

No seu próprio servidor Node.js, crie o cliente com secretKey em vez de clientKey para usar server.getPlayer() e server.submitScore(). O SDK recusa uma chave secreta no navegador.

JavaScript
// Node.js on your own server only: the secret key never goes to a browser or game build
const Majacloud = require('./majacloud.js');
const admin = Majacloud.createClient({
  baseUrl: 'https://majacloud.majanite.com',
  projectId: process.env.MAJACLOUD_PROJECT_ID,
  secretKey: process.env.MAJACLOUD_SECRET_KEY,
});

const player = await admin.server.getPlayer('player_3f9c…');
await admin.server.submitScore('coins', 'player_3f9c…', 980);

mc.request(method, path, { body, auth }) chama qualquer endpoint sem um helper, por exemplo mc.request('GET', '/wallet', { auth: 'player' }).

Busca em títulos de páginas, seções e texto.

↑↓ para navegar ↵ para abrir Esc para fechar