Saltar al contenido principal

​
Autenticación mediante claves de API

Todas las solicitudes a la API deben incluir una clave de API en las cabeceras. La clave se envía mediante la cabecera x-api-key.

​
Crear claves de API

Puedes crear y gestionar las claves de API desde el panel de tu organización.

Gestionar claves de API

Crea, consulta y gestiona las claves de API en los ajustes de tu organización

​
Ámbito de las claves de API

Las claves de API pertenecen a una organización y pueden restringirse a sitios web concretos de esa organización. Esto permite controlar el acceso con precisión cuando gestionas varios sitios web dentro de una misma organización.
  • Cada clave de API está asociada a una organización.
  • Una organización puede contener varios sitios web.
  • Puedes restringir una clave de API a uno o varios sitios web de la organización.
  • Las claves restringidas solo tienen acceso a los datos de los sitios web que tienen asignados.

​
Claves globales y restringidas

Una clave global abarca toda la organización; una clave restringida solo permite acceder a los sitios web que tiene asignados. Algunos endpoints de la organización requieren una clave global y rechazan las claves restringidas con 403 Forbidden: global API key required:
  • Gestión de roles: todos los endpoints /api/v1/roles.
  • Miembros de la organización: /api/v1/organizations/members/{user_id} (actualizar o eliminar).
  • Grupos: gestión de /api/v1/groups y de sus miembros.
  • Invitaciones a organizaciones y grupos: POST /api/v1/invites con type: "organization" o type: "group". Las invitaciones a sitios web también funcionan con una clave restringida que incluya el sitio web de destino.
Las claves globales equivalen a permisos de administrador. Solo un administrador o propietario de la organización puede crearlas, por lo que estos endpoints exigen los mismos permisos que el panel.
Solo los administradores de la organización pueden crear, editar o eliminar claves de API. Comprueba que tienes los permisos necesarios antes de gestionar las claves.