filudi developers

For portal developers

A game site on the Filudi API

A portal is a site of yours that lists games from the Filudi catalog and runs them in frames. Players get saves, leaderboards and accounts from the API; you get the catalog, the handshake and statistics. Pick how much you build yourself.

Request an invitation Portal documentation

Three ways to build one

  1. A front on hub-core

    Install @filudi/hub-core from npm. Its fetchCatalog, GameFrame and PlayerClient give you the catalog, the frame with its handshake and the player's state; tokens.css gives you the design tokens. You draw the screens.

  2. Your own front

    Read the public catalog, GET /v1/catalog/{site}, embed each game's frame and run the handshake yourself: a player token, a game token exchanged for one game, and the messages the SDK posts. Any stack, any language.

  3. A backend with server keys

    Create a key in the console and call /v1/server/* from your servers: players by your own user id, tokens for the browser, leaderboards, statistics. 600 requests a minute per key, scoped to what the key allows.

Approval of a site and its domains

You create the site from the console. It is pending until staff approves it; meanwhile it works from the console and on the development origins, so you can build before anyone sees it. Propose the domains the site will run on; each one joins the allowed origins once staff approves it, and the API answers your pages from then on.

What a portal may list

An approved game whose developer set its distribution to any portal and that has a live version. Add it to your catalog from the console, order it, write your own titles and descriptions per locale, sort it into your own categories. When an add is refused, the console says why.

Statistics

The same set as for games, for your site across its games: active players per day and over rolling 7 and 30 days, sessions, retention, the funnel, splits by host, version, locale and device. From the console or, with a key, from /v1/server/stats/*.

Going live

A catalog change shows on your pages when you publish it from the console. Filudi's own site, filudi.com, is built the first way and is the reference for what hub-core does.