Crear y proteger inserciones

Crea una URL pública de una hoja, limita dónde se puede insertar y entiende su caché y revocación.

Dirigido a: Integradores web y de plataformas LMS
Antes de empezar: Una clave para servidor y la lista de sitios que podrán insertar la hoja

Crear una inserción

POST /embeds genera una hoja fija, la guarda y devuelve embedId y embedUrl. La creación completada usa bloques de crédito; las visualizaciones posteriores son gratuitas.

curl -X POST "https://overthemathwall.com/api/public/v1/embeds" \
  -H "Authorization: Bearer $OTMW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "seed": 42,
    "locale": "en",
    "title": "Warm-up",
    "showAnswerKey": false,
    "allowedDomains": ["example.com", "*.school.edu"],
    "entries": [
      {"id":"warmup-1","grade":"grade3","topic":"multiplication","difficulty":"easy","count":5}
    ]
  }'

<iframe
  src="https://overthemathwall.com/embed/emb_..."
  width="100%"
  height="800"
  title="Math worksheet"
></iframe>

Dominios permitidos y CSP

Omite allowedDomains para permitir que cualquier sitio enmarque la URL.
Incluye hasta 20 hosts; se aceptan patrones como example.com, *.example.org y hosts con puerto para desarrollo.
La lista se convierte en la directiva CSP frame-ancestors junto con 'self'. Prueba el dominio exacto y sus subdominios: un comodín no siempre cubre el dominio raíz.

Respuestas y datos

Si showAnswerKey es true, cualquier visitante de la URL puede ver las respuestas. No uses una inserción para evaluaciones secretas. No incluyas nombres, identificadores ni otros datos personales de estudiantes en el título o en sistemas que construyan la solicitud.

Caché y revocación

La hoja generada se guarda con la inserción para que las visitas públicas no generen de nuevo el contenido. La respuesta pública puede permanecer en caché hasta cinco minutos. Por eso una revocación puede tardar hasta cinco minutos en verse en todas las cachés. Una URL revocada o desconocida devuelve el mismo 404.

No existe una operación pública para editar una inserción. Para cambiar contenido, respuestas o dominios, crea otra, actualiza tu iframe y revoca la anterior.