Claves
Las claves de ingesta solo escriben y son públicas por diseño; las de servidor, lectura y administración se quedan en un servidor.
Una clave (key) pertenece a un proyecto y tiene uno de cuatro alcances. Su prefijo dice cuál.
| Alcance | Prefijo | Nombre en el panel | Qué puede hacer | Dónde vive |
|---|---|---|---|---|
| Ingesta | lyr_ing_ | Send events | Añadir eventos, nada más | Dentro de tu app o tu página web |
| Servidor | lyr_srv_ | Send events from a server | Añadir eventos, nada más. Sus eventos están verificados. | Solo en tu backend. Mantenla en secreto. |
| Lectura | lyr_read_ | Read events | Consultar eventos | Un servidor o un script. Mantenla en secreto. |
| Administración | lyr_adm_ | Full access | Enviar eventos y consultarlos, para tareas de administración | Un servidor. Mantenla en secreto. |
Una clave de lectura consulta los eventos de su proyecto a través de la API de lectura: desde un script, un notebook o un agente en un servidor. Lee todo lo que guarda el proyecto, así que nunca va en una app ni en una página web.
Una clave de servidor envía eventos desde tu backend: desde el SDK de Node, Python, Go o JVM, o
con curl. Igual que una clave de ingesta, no puede leer, pero es secreta: los eventos que envía
quedan marcados como verificados, porque solo la tienen tus servidores,
y la cuota diaria de una dirección de origen
no se le aplica. Nunca va en una app ni en
una página web. Las apps y las páginas web usan la clave de ingesta.
Por qué una clave de ingesta puede ser pública
Una clave de ingesta va dentro del binario de tu app o de tu página web, así que da por hecho que
cualquiera puede leerla. No pasa nada, porque solo puede añadir eventos a su proyecto: no puede
leer, cambiar ni borrar nada. El proyecto en el que acaba un evento sale siempre de la clave,
nunca del evento. Para limitar el abuso, cada proyecto tiene un límite de frecuencia (60.000
eventos por minuto por defecto), y un lote que lo supera recibe 429. Además, con ella una
dirección solo puede enviar una cuota diaria
del mes de la organización.
La otra cara: cualquiera que tenga la clave de ingesta puede enviar eventos como los de tu app, así que no están verificados, salvo que vengan de tu app de Apple y Apple lo demuestre con App Attest, o de tu app de Android y el teléfono lo demuestre con Key Attestation. Esos eventos tampoco cuentan para la cuota diaria.
Las claves se muestran una vez
Lyrelog guarda solo un hash SHA-256 de cada clave. Ves la clave una vez, al crearla: cópiala en ese momento. Una clave perdida no se puede recuperar; crea una nueva.
Crear y revocar
Las claves están en la página API keys del proyecto: Settings y luego API keys, o ⌘ K y API keys. Solo los propietarios pueden crearlas y revocarlas.
- Un proyecto tiene como máximo 20 claves activas. Revoca una para crear otra.
- Las claves no caducan: una clave funciona hasta que se revoca o hasta que se borra su proyecto.
- Crear una clave Send events from a server, Read events o Full access requiere haber iniciado sesión hace poco (en los últimos 10 minutos). Las claves Send events, no.
- Cuando alguien se va de una organización o lo quitan, se revocan las claves de lectura y de acceso total que creó. Las claves de ingesta siguen activas, porque las apps que ya están publicadas envían con ellas. Las claves de servidor también siguen activas, porque tus servidores envían con ellas: si la persona que se fue vio alguna, revócala y sustitúyela.
- Todas las personas de la organización ven la lista de claves y cuándo se usó cada una por última vez.
Una clave revocada deja de funcionar al instante; cuenta con hasta un minuto. Un SDK que recibe
401 o 403 deja de enviar hasta que la app se reinicia, y conserva los eventos en cola.