Developer docs

1. 1

   Install

   npm install playmez-embed

   One script tag, or npm install playmez-embed. Any site, any framework.

2. 2

   Ask your server for a launch link

   Your API key stays on your server. Each link is for one player and works once, within five minutes.

   launch.mjsCopy

   // Node 18+. The API key stays on your server; the page or app only ever sees launchUrl.
   const res = await fetch("https://api.playmez.com/partner/launch", {
     method: "POST",
     headers: { "Content-Type": "application/json", "X-Api-Key": process.env.PLAYMEZ_API_KEY },
     body: JSON.stringify({ game: "ludo", externalUserId: user.id, displayName: user.name }),
   });
   const { launchUrl } = await res.json(); // one use, valid for five minutes
   // Drop-in helper with error handling: https://playmez.com/sdk/server/launch.mjs

3. 3

   Show the game

   index.htmlCopy

   <!-- launchUrl comes from your server (see step 2). -->
   <script src="https://playmez.com/sdk/playmez.js"></script>
   <div id="ludo-game"></div>
   <script>
     const game = Playmez.mount(document.getElementById("ludo-game"), {
       launchUrl,
       height: 720,
       title: "Ludo",
       onEvent: (e) => {
         if (e.type === "ready") console.log("Ludo open");
         if (e.type === "result") console.log(e.won ? "won" : "lost", e.net, "points"); // one event when the match ends
         if (e.type === "close") showYourOwnScreenAgain();
         if (e.type === "error") console.error(e.code, e.message); // fetch a new launchUrl
       },
     });
     // game.unmount() removes the frame.
   </script>

Testing? Your portal's Try it tab launches a real game with your key and shows the events and the server call side by side.

• mode: "online"

  Your players, playmez.com players and every other partner in the network, matched in one pool. Needs the network switched on in your portal.

  Your two stranger switches decide whether your players can talk with people from outside your app.

• tableCode

  Only the people launched with that code, from any of your apps (web, React Native, Flutter, Android, iOS), plus anyone you give the playmez.com join link to. Another partner's launch is refused.

  Your own-table chat and voice switches.

• mode: "local"

  Offline on the phone: alone against the computer in every game, or people passing the phone (Ludo, Chess, Carrom, 8-Ball Pool). Nobody from outside, and names stay on the phone.

  Chat and voice off: nobody else is at the table.

• no mode (default)

  The computer only. Nobody from outside.

  Chat and voice off.

• No 2xx within 10 seconds, a redirect or a connection error: tried again after 1 min, 5 min, 30 min, 2 h, 8 h and 24 h, then marked failed.
• Retries resend the same body and the same Playmez-Delivery id. Keep handling idempotent.
• GET /partner/webhook/deliveries lists status, attempts and the last answer; POST /partner/webhook/deliveries/:id/redeliver queues one again. Kept 30 days.
• The player object carries your externalUserId and the display name only, never the Playmez username or balance.
• Full copy-paste receivers for Node and Python are in the drop-in files below.