Web API de variables

Abre la API pública de variables de tu sala: genera las claves con las que una herramienta externa lee y escribe tus variables permanentes.

Cómo funciona

El complemento no hace nada dentro de una pila: es la caja de las claves de la API de tu sala. Lo colocas en la sala —en cualquier baldosa, no va con ninguna pila ni con ninguna caja de variable—, lo abres con doble clic y generas una clave de lectura, una de escritura, o las dos. Con ellas, un programa de fuera puede pedir y cambiar las variables de la sala. Cómo se hacen las peticiones, qué se puede pedir y los límites están en API pública de variables.

Las dos claves son independientes:

• Con la clave de lectura se consulta: los nombres de las variables, sus valores, quién las tiene.
• Con la clave de escritura se cambia: dar una variable, cambiar su valor, quitarla. No sirve para leer: una herramienta que lea y escriba necesita las dos.
• Si dejas una vacía, ese tipo de operación queda cerrado para todos. Con las dos vacías, la API de tu sala rechaza todas las peticiones.

Solo el dueño de la sala ve las claves, las genera y las guarda. Cualquier otra persona con derechos puede abrir y guardar la caja, pero la ve con las claves vacías y no puede tocarlas.

En el catálogo aparece como Complemento de Variable Global: Web API.

Las claves

Son cadenas largas y aleatorias, de 43 caracteres (letras, cifras, - y _), que las genera el hotel: no se pueden escribir a mano. Una clave nueva no vale hasta que guardas el complemento con Listo, y al guardar la anterior deja de valer al instante. Es la forma de cambiar una clave que se ha filtrado.

Permitir eliminación masiva

Una casilla en Permisos adicionales que abre la ruta de borrado masivo: quitar de golpe todos los valores de una o varias variables. Está apagada de fábrica y en gris mientras no haya clave de escritura. Al marcarla sale una confirmación de peligro, y solo se marca si aceptas.

Configuración

La ventana es un 40 % más ancha que una ventana de wired normal. De arriba abajo:

Sección	Qué hay
Advertencia de uso:	Un aviso en rojo: las claves sirven para leer y escribir variables desde puntos de enlace HTTPS dedicados, nadie más puede ver el contenido de la caja y no debes compartirlas con quien no sea de confianza. Añade que, tras cambiar la configuración de las variables, puede que tengas que cargar la sala de nuevo para que la API funcione bien
Clave API para lectura:	Tres botones —Generar (pasa a Regenerar si ya hay clave), Limpiar y Copiar— y debajo el cuadro con la clave, que solo se lee
Clave API para escritura:	Lo mismo, para la clave de escritura
Permisos adicionales:	La casilla Permitir eliminación masiva, con el aviso «Permite el acceso al punto de enlace /variables/bulk-delete. ¡Úsalo con precaución!»

Limpiar y Copiar salen en gris si no hay clave. Copiar la lleva al portapapeles y avisa con «Clave API copiada con éxito al portapapeles». Limpiar solo vacía el cuadro: la clave deja de valer cuando guardas.

La confirmación de Permitir eliminación masiva se titula «¿Estás segur@?» y explica que llamar sin querer a esa ruta elimina de forma irreversible todo el contenido de las variables, y que pruebes tu aplicación primero con variables de prueba en otra sala.

Si al guardar sale «Claves de la API web no válidas», es que una de las claves no es la que generó esta caja. Genera otra y vuelve a guardar.

Ejemplo

Un servidor tuyo que consulta la clasificación de tu sala y la enseña en una página web, sin poder cambiar nada: solo necesita la clave de lectura.

Complemento: Web API de variables
├─ Clave API para lectura ....................... Generar, luego Listo
├─ Clave API para escritura ..................... vacía
└─ Permisos adicionales
     └─ Permitir eliminación masiva ............. sin marcar

Pulsa Generar en la clave de lectura, Copiar, y Listo. Hasta ese último paso la clave no abre nada. Tu servidor usa la clave en cada petición y, como la de escritura está vacía, nadie puede cambiar ni borrar ningún valor con ella.

Notas

La clave que generas no vale hasta que pulsas Listo. Si cierras la ventana sin guardar, la API sigue como estaba.

Regenerar cierra la puerta a quien tuviera la clave anterior. Es lo que haces si sospechas que una clave se ha visto: genera otra, guarda, y la vieja deja de funcionar.

Solo se ven las variables permanentes y las compartidas entre salas de esta sala. Las variables que se pierden al salir o al vaciarse la sala no existen para la API, ni tampoco las heredadas ni las internas.

Una variable nueva, o una a la que le cambias el nombre, puede tardar en verse. La API trabaja con las variables permanentes tal como estaban cuando se cargó la sala; hasta que la sala se vacía y se vuelve a cargar, la nueva no aparece y la renombrada sigue con el nombre viejo. Recoger una caja, en cambio, se nota al momento, y las compartidas entre salas se ven al instante.

Las escrituras de la API cuentan como un cambio de variable. Con la sala cargada, hacen saltar el causante Cambio de variable si tiene marcada la casilla Externa de Permitir activación desde; con ella desmarcada, esa pila no se entera. Con la sala vacía y descargada no corre ningún wired.

Con uno basta. Si colocas varios en la misma sala, la clave de cualquiera abre la API entera, y el borrado masivo depende de la caja cuya clave de escritura uses. Es más cómodo y más seguro tener uno solo.

Recoger el complemento borra las claves. Antes de hacerlo el cliente te pide confirmar: la API dejará de funcionar para la sala y, cuando lo vuelvas a colocar, las claves serán otras. Lo mismo pasa si vendes la sala: las claves del dueño anterior se borran, y el nuevo dueño genera las suyas.

Quien tiene la clave de escritura puede cambiar los valores de tu sala. Si de esos valores salen recompensas o puntuaciones, trátala como una contraseña. Los consejos están en la API pública de variables.