MAJACLOUDWeb-SDK
Eine JavaScript-Datei ohne Abhängigkeiten für HTML5-Spiele, Websites und Node.js-Server.
Codekommentare und API-Namen bleiben auf Englisch, damit sie zu den SDKs passen.
Voraussetzungen#
- Aktuelle Versionen von Chrome, Edge, Firefox und Safari (Desktop und Mobil) oder Node.js 18+.
- Die Seite muss über HTTPS (oder localhost) ausgeliefert werden: Die API verlangt HTTPS, und Web Crypto, mit dem die Remote-Konfiguration geprüft wird, gibt es nur auf sicheren Seiten.
Installation#
Laden Sie die Datei von Ihrem MAJACLOUD-Server, der sie mit CORS-Headern ausliefert:
<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>Oder kopieren Sie majacloud.js in Ihr Projekt:
// Bundlers (Vite, webpack…): copy majacloud.js into your project
import Majacloud from './majacloud.js';
// Node.js 18+
const Majacloud = require('./majacloud.js');Client erstellen#
Nur baseUrl, projectId und clientKey sind erforderlich.
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
});Ergebnisse#
Jeder Aufruf wird zu { ok: true, value } oder { ok: false, error } aufgelöst und nie abgelehnt. value ist der Body der REST-Antwort ohne ok, mit denselben snake_case-Feldern wie in der REST-Referenz.
error enthält code, message, status, requestId, retryAfter, details und retryable.
Events#
Abonnieren Sie Events mit on(); die Methode gibt eine Funktion zum Abbestellen zurück.
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 functionEine Bestenliste auf Ihrer Website#
Zum Lesen einer Bestenliste ist keine Anmeldung nötig, daher kann eine Website Ihre besten Spieler allein mit dem öffentlichen Client-Schlüssel anzeigen:
<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>Mehrere Tabs#
Die Sitzung liegt in localStorage und wird von allen Tabs Ihrer Website geteilt. Refresh-Tokens rotieren, daher erneuern die Tabs abwechselnd (Web Locks) und übernehmen die neuen Tokens der anderen: Ein zweiter Tab meldet Spieler nie ab.
Serverseitig mit dem geheimen Schlüssel#
Erstellen Sie den Client auf Ihrem eigenen Node.js-Server mit secretKey statt clientKey, um server.getPlayer() und server.submitScore() zu nutzen. Im Browser lehnt das SDK einen geheimen Schlüssel ab.
// 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 }) ruft jeden Endpunkt ohne Hilfsmethode auf, zum Beispiel mc.request('GET', '/wallet', { auth: 'player' }).