Runtime de stickers hébergés

Utilisez MediaRuntime comme backend de stickers pour votre application.

Activez un Hosted Pack, activez-le dans une collection d’application, puis utilisez l’autocomplétion, la recherche, les métadonnées et la résolution de ressources à durée de vie limitée liées à cette collection. La clé API du workspace doit rester sur votre serveur de confiance.

Vue d’ensemble
Pack
Ensemble payant et versionné de ressources de stickers publiées, disponible pour le workspace.
Collection
Configuration gratuite de l’application qui détermine les packs activés qu’une application peut découvrir.
Sticker
Enregistrement stable de métadonnées, sélectionné par la recherche et affiché au moyen d’une variante approuvée.
Configuration

Les collections n’achètent pas de packs

Une collection est une configuration gratuite de l’application qui s’appuie sur des Hosted Packs déjà activés pour le workspace. La désactivation d’un pack le retire des nouvelles recherches et suggestions d’autocomplétion, tandis que la liaison conservée peut permettre de restituer à l’identique les anciens messages.

  1. 01

    Activez un Hosted Pack

    L’activation payante appartient au workspace.

  2. 02

    Créez une collection

    Utilisez une collection par application ou par périmètre de règles applicable aux stickers.

  3. 03

    Activez le pack

    La collection peut désormais exposer ce pack au moyen des opérations de lecture du runtime.

Contrat d’interaction

L’autocomplétion lance la recherche ; elle ne récupère pas les stickers

L’autocomplétion renvoie un texte de suggestion tel que plage. Recherchez la suggestion sélectionnée pour obtenir les enregistrements de stickers. Conservez et transmettez stickerId aux appels de métadonnées et de résolution ; semanticId décrit le sens et n’est pas accepté comme identifiant du sticker dans le chemin.

Bash

Testez le parcours complet avec la CLI

# The API key stays in trusted server-side environment configuration.
export MEDIARUNTIME_API_KEY="sk_..."
collection_id='stc_11111111111111111111111111111111'

# Typeahead returns suggestion text, not stickers or delivery URLs.
mediaruntime stickers typeahead "pla"   --collection "$collection_id"   --locale fr   --limit 10   --json

# Search the selected suggestion to obtain complete sticker records.
mediaruntime stickers search "plage"   --collection "$collection_id"   --limit 10   --json

# Use stickerId—not semanticId—for metadata and asset routes.
sticker_id='sage-the-owl-summer-season-vacation-v1-beach-day'
mediaruntime stickers get "$sticker_id" --collection "$collection_id" --json

# Resolve only when the UI needs an approved representation.
mediaruntime stickers resolve "$sticker_id"   --variant small_160   --collection "$collection_id"   --json
SDK officiels

Implémentez dans votre application le même parcours lié à une collection.

Implémentez l’autocomplétion avec le SDK Node
// npm install @mediaruntime/node
import { MediaRuntime } from "@mediaruntime/node";

// Never expose the workspace API key in browser or mobile code.
const media = new MediaRuntime({ apiKey: process.env.MEDIARUNTIME_API_KEY });
const stickers = media.stickers.collection("stc_11111111111111111111111111111111");

// Show these suggestion texts while the user types.
const typeahead = await stickers.typeahead("pla", { locale: "fr", limit: 10 });
const selectedTerm = typeahead.suggestions[0]?.text;
if (!selectedTerm) throw new Error("No sticker suggestion matched");

// Search turns the selected term into stable sticker records.
const matches = await stickers.search(selectedTerm, { limit: 10 });
const selectedSticker = matches.items[0];
if (!selectedSticker) throw new Error("No sticker matched the selected suggestion");

// Persist stickerId in the message; signed delivery URLs expire.
const asset = await stickers.resolve(selectedSticker.stickerId, "small_160");
console.log(selectedSticker.stickerId, asset.url);

Clé de serveur ou jeton client à portée limitée

Les serveurs de confiance peuvent utiliser directement MEDIARUNTIME_API_KEY. Les applications web et mobiles peuvent recevoir un jeton facultatif à durée de vie limitée, émis par le serveur de confiance et restreint à une collection ainsi qu’à des portées explicites du runtime.

Conservez les références, pas les URL

Stockez stickerId, packId et packVersion avec le message. Résolvez une variante approuvée au moment de l’affichage, car son URL de livraison, épinglée à une génération précise, est volontairement éphémère.

Référence REST

Endpoints des collections de stickers et du runtime.

MéthodeCheminRôle
GET/v1/sticker-collectionsRépertorie les collections d’applications appartenant au workspace.
PUT/v1/sticker-collections/{collection_id}/packs/{pack_id}Active dans une collection un Hosted Pack déjà activé.
GET/v1/stickers/packsRépertorie les packs activés pour un collection_id explicite.
GET/v1/stickers/typeaheadRenvoie un texte de suggestion adapté à la langue ; ne renvoie pas d’identifiants de stickers.
GET/v1/stickers/searchRecherche les métadonnées des stickers activés et renvoie des valeurs stickerId stables.
GET/v1/stickers/{sticker_id}Récupère un sticker au moyen de stickerId, et non de semanticId.
GET/v1/stickers/{sticker_id}/assets/{variant}Renvoie une URL de livraison éphémère, épinglée à une génération précise.
POST/v1/sticker-runtime/client-tokensÉmet un jeton client facultatif et éphémère, limité à une collection.
GET/v1/sticker-runtime/usage/currentConsulte les opérations mutualisées en cours et les livraisons autorisées.