Una clave de API permite que su propio software se comunique con su plataforma a través de la API REST, por ejemplo para leer miembros, inscribir a alguien en un curso o conectar un sitio de WordPress. Cada clave es una contraseña secreta para un programa, así que usted decide por clave qué puede hacer y puede sustituirla o eliminarla en cualquier momento.
Quién puede gestionar las claves de API
API está en el bloque Integraciones y API del menú de configuración. Su rol necesita Gestionar claves de API además de Actualizar configuración de la plataforma. Este permiso nunca está disponible para un rol personalizado, así que solo los roles integrados Propietario y Administrador pueden trabajar aquí. El mismo permiso abre también Apps de OAuth e Inicio de sesión único.
El acceso a la API depende de su plan. Si su plan no lo incluye, la página muestra «El acceso a la API está incluido en todos los planes de pago. Cambie de plan para crear claves de API.» junto con Cambiar de plan, y Nueva clave de API sigue desactivado. La API rechaza las claves que ya existen hasta que el plan vuelva a incluirla.
Crear una clave
Haga clic en Nueva clave de API. Se abre el diálogo Crear clave API.
- Introduzca un Nombre de la clave que le indique más adelante quién usa la clave, por ejemplo la herramienta o el sitio web al que pertenece. El nombre es obligatorio.
- Decida qué puede hacer la clave. Una clave nueva empieza con acceso completo, así que todos los permisos están seleccionados.
- Haga clic en Crear.
Para restringir la clave, haga clic en Limitar a permisos específicos. Se quitan todos los permisos y usted elige los que necesita. Los permisos se agrupan por área, como Miembros, Grupos, Cursos o Pagos, y cada área enumera acciones como Ver o Gestionar con una breve descripción. Seleccionar todo y Deseleccionar todo cambian un área entera de una vez. Un contador muestra cuántos permisos tiene la clave. Una clave necesita al menos un permiso, y Restablecer al acceso completo vuelve a seleccionarlos todos.
Después de hacer clic en Crear, el diálogo Tu nueva clave API muestra la clave completa una sola vez. Cópiela y guárdela en un lugar seguro. Después, la lista solo muestra los cuatro últimos caracteres, y nadie puede volver a mostrar la clave completa.
Usar una clave
El recuadro Documentación de la API sobre la lista muestra la URL base de la API con un botón para copiarla, y Abrir documentación lleva a la referencia interactiva con todos los endpoints.
Envíe la clave con cada solicitud, ya sea como token Bearer en la cabecera
Authorization o en la cabecera X-Api-Key. Las claves empiezan por mak_.
Se rechaza una solicitud que necesita un permiso que la clave no tiene.
Una clave está ligada al miembro del equipo que la creó. Si esa persona ya no pertenece a su espacio de trabajo, la clave deja de funcionar, así que cree las claves para conexiones de larga duración con una cuenta que vaya a permanecer.
La lista muestra cada clave con Nombre, Clave, Último uso y Creado. Último uso se actualiza como mucho una vez por minuto, lo que basta para ver si una clave sigue en uso.
Cambiar, rotar y eliminar una clave
Haga clic en una clave de la lista, o use Editar, el icono del lápiz de su fila, para cambiar su nombre o sus permisos. Los cambios se aplican con Guardar.
Si una clave puede haberse filtrado, rótela. Rotar clave en el mismo diálogo pregunta: «¿Rotar esta clave? El secreto antiguo dejará de funcionar de inmediato y las integraciones externas necesitarán el nuevo.» Después de confirmar, la clave nueva aparece una sola vez en Tu nueva clave API. El nombre y los permisos se mantienen, y Último uso empieza de cero. Introduzca la clave nueva en cada herramienta que usaba la antigua.
Para quitar una clave, use Eliminar, el icono de la papelera de su fila, o Eliminar en el diálogo abierto, y confirme. A partir de entonces se rechaza cada herramienta que todavía la use.
Apps de OAuth, inicio de sesión único y webhooks
Pegar una clave no es la única forma de conectar:
- Apps de OAuth permite que otras MemberAreas conecten su software con OAuth en lugar de una clave de API pegada.
- Inicio de sesión único inicia la sesión de los miembros desde otro sistema. Se describe en Inicio de sesión, registro y SSO.
- Los webhooks para eventos de miembros y de pagos tienen su propia página en Configuraciones > Webhooks, que aparece en cuanto Pagos está activado.