Claves de API

Una clave de API pertenece exactamente a un proyecto y hace lo que indican sus alcances. Puedes limitarla aún más a modelos y operaciones concretos, o confinarla a una organización.

Claves públicas y secretas

Hay dos tipos, que se distinguen por el prefijo. Una clave pública (pk_) es segura para enviar en un navegador. Por sí sola es de solo lectura y devuelve contenido publicado, y un usuario con sesión iniciada añade los alcances de su propio rol. Una clave secreta (sk_) es para un servidor, y la API rechaza una en cualquier solicitud que lleve un encabezado Origin de navegador. Ambos tipos se crean dentro de un proyecto y sirven solo a ese proyecto.

Alcances

Los alcances fijan el tipo de acceso que tiene una clave, como records:read o ejecutar operaciones. La comprobación es una lista de permitidos, así que se rechaza una llamada cuyo alcance la clave no tiene. Un alcance permite una llamada y nunca amplía qué filas devuelve una consulta. Algunos alcances no pueden tenerlos en absoluto las claves públicas, y pedir uno se rechaza al crear la clave.

Limitar a modelos y operaciones

Dos selectores en una clave fijan a qué recursos llega: acceso a modelos y acceso a operaciones. Ambos son por defecto todos, es decir, todo lo que cubren los alcances de la clave, así que limitar es opcional. Si eliges modelos concretos, los campos tipados de cualquier otro modelo desaparecen del esquema que ve esa clave, y las llamadas a ellos se deniegan. Si eliges operaciones concretas, la mutación de una operación no listada está ausente del esquema de la clave, incluida la introspección.

Confinamiento a una organización

Una clave se puede confinar a una organización al crearla. Lee esa organización, todo lo que está debajo y las filas compartidas en el proyecto, y escribe solo lo propio. Debe indicar al menos un alcance, no puede generar claves y se elimina junto con su organización.

Rotación y cambios posteriores

Rotar una clave mantiene operativo el secreto anterior durante 24 horas. Revocar termina todos los secretos de inmediato. Los alcances, los modelos permitidos y el nombre se pueden editar en una clave existente y surten efecto al guardar. El tipo de clave, el confinamiento y la caducidad quedan fijados al crearla.

Lee el detalle

La guía de claves de API cubre ambos tipos de clave, sus alcances, cómo restringir el alcance de una clave y la rotación.