Guías

API Keys

Genera y gestiona API Keys para integraciones servidor-a-servidor.

Las API Keys permiten que sistemas externos se conecten a tu Organización en Inspow mediante integraciones servidor-a-servidor, sin iniciar sesión como Usuario. Cada clave pertenece a una Organización y solo accede a sus datos.

Generar una API Key

Al crear una clave indicas un nombre (de 3 a 100 caracteres), una descripción opcional y sus permisos (scopes). De forma opcional puedes fijar una fecha de expiración, un límite de peticiones por hora (entre 1 y 10 000, por defecto 1000), una lista de orígenes (dominios) permitidos y una lista de IPs permitidas.

Permisos (scopes)

Scope	Acceso
`read_only`	Solo lectura (valor por defecto)
`write_only`	Solo escritura
`read_write`	Lectura y escritura
`admin`	Acceso total; cubre cualquier otro permiso requerido
`device`	Exclusivo de dispositivos de asistencia (kioscos/lectores): solo sirve en los endpoints de dispositivos y no da acceso al resto de la API

Estados de la clave

Estado	Significado
`active`	Activa y operativa
`inactive`	Inactiva
`revoked`	Revocada manualmente
`expired`	Caducada por su fecha de expiración

Solo las claves en estado active permiten autenticar peticiones.

Gestionar y revocar

Puedes listar tus claves (con filtros y búsqueda), consultar una por su identificador, actualizar sus datos, revocar una clave (queda en estado revoked y deja de funcionar) y eliminarla de forma permanente. Cada clave guarda su contador de uso, su última fecha de uso y un historial reciente de peticiones.

Uso servidor-a-servidor

Envía la clave en cada petición mediante la cabecera X-API-Key, o bien en Authorization con el prefijo Bearer o ApiKey. Las peticiones con clave inválida, revocada o expirada se rechazan; si superas el límite por hora, la petición se rechaza con 403 («Rate limit excedido») hasta que corra la hora; lo mismo si llega desde una IP o un dominio que no están en las listas permitidas.

curl https://api.inspow.tech/api/v1/restaurant/plans \
  -H "X-API-Key: ak_xxxxxxxx.xxxxxxxxxxxxxxxx"

Qué datos alcanza

Una API Key accede a los datos de su Organización (Planes, Suscripciones, Facturas, Beneficiarios, Registros de Asistencia, etc.), con el alcance de sus scopes. En los endpoints, las personas atendidas son siempre beneficiaries, sea cual sea el sector (Miembros, Estudiantes, Socios, Coworkers o Pacientes en la app).