Runtime de stickers alojados

Usa MediaRuntime como backend de stickers de tu aplicación.

Activa un Hosted Pack, habilítalo en una colección de la aplicación y utiliza el autocompletado, la búsqueda, los metadatos y la resolución de recursos de corta duración asociados a esa colección. La clave de API del workspace debe permanecer en tu servidor de confianza.

Descripción general
Pack
Conjunto de recursos de stickers publicados, de pago y con control de versiones, disponible para el workspace.
Colección
Configuración gratuita de la aplicación que controla qué packs activados puede descubrir una aplicación.
Sticker
Registro estable de metadatos que se selecciona mediante búsqueda y se muestra mediante una variante aprobada.
Configuración

Las colecciones no compran packs

Una colección es una configuración gratuita de la aplicación que utiliza Hosted Packs ya activados para el workspace. Al deshabilitar un pack, este deja de aparecer en las nuevas búsquedas y sugerencias de autocompletado, mientras que la vinculación conservada puede permitir que los mensajes históricos se sigan mostrando exactamente como antes.

  1. 01

    Activa un Hosted Pack

    La activación de pago pertenece al workspace.

  2. 02

    Crea una colección

    Usa una colección por cada aplicación o límite de políticas de stickers.

  3. 03

    Habilita el pack

    La colección ya puede exponer ese pack mediante las lecturas del runtime.

Contrato de interacción

El autocompletado inicia la búsqueda; no recupera stickers

El autocompletado devuelve texto de sugerencia, como playa. Busca la sugerencia seleccionada para obtener registros de stickers. Conserva y pasa stickerId a las llamadas de metadatos y resolución; semanticId describe el significado y no se acepta como identificador del sticker en la ruta.

Bash

Prueba el flujo completo con 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 es   --limit 10   --json

# Search the selected suggestion to obtain complete sticker records.
mediaruntime stickers search "playa"   --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 oficiales

Implementa en tu aplicación el mismo flujo vinculado a una colección.

Implementa el autocompletado con el SDK de 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: "es", 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);

Clave de servidor o token de cliente con ámbito limitado

Los servidores de confianza pueden usar MEDIARUNTIME_API_KEY directamente. Las aplicaciones web y móviles deben recibir, de forma opcional, un token de corta duración emitido por el servidor de confianza y restringido a una colección y a ámbitos explícitos del runtime.

Conserva referencias, no URLs

Guarda stickerId, packId y packVersion con el mensaje. Resuelve una variante aprobada en el momento de mostrarla, porque su URL de entrega, fijada a una generación concreta, tiene una duración corta de forma intencionada.

Referencia REST

Endpoints de colecciones de stickers y del runtime.

MétodoRutaFinalidad
GET/v1/sticker-collectionsEnumera las colecciones de aplicaciones que pertenecen al workspace.
PUT/v1/sticker-collections/{collection_id}/packs/{pack_id}Habilita en una colección un Hosted Pack que ya está activado.
GET/v1/stickers/packsEnumera los packs habilitados para un collection_id explícito.
GET/v1/stickers/typeaheadDevuelve texto de sugerencia adaptado al idioma; no devuelve identificadores de stickers.
GET/v1/stickers/searchBusca metadatos de stickers habilitados y devuelve valores stickerId estables.
GET/v1/stickers/{sticker_id}Recupera un sticker mediante stickerId, no mediante semanticId.
GET/v1/stickers/{sticker_id}/assets/{variant}Devuelve una URL de entrega de corta duración, fijada a una generación concreta.
POST/v1/sticker-runtime/client-tokensEmite un token de cliente opcional y de corta duración, limitado a una colección.
GET/v1/sticker-runtime/usage/currentConsulta las operaciones agrupadas actuales y las entregas autorizadas.