Guía práctica

Crear una clave de API

Cree una clave de API con los permisos adecuados, guarde el token de forma segura y haga su primera solicitud a la API.

Una clave de API permite que un programa actúe sobre los datos de su cuenta a través de la API de LocalUp o del servidor MCP. Esta guía muestra cómo crear una con solo el acceso que necesita y cómo mantenerla segura.

Antes de empezar:

  • El acceso a la API debe estar activado para su cuenta (el elemento API está en la barra lateral) y su rol debe permitir gestionar claves de API.
  • Decida qué debe hacer la integración (leer reseñas, actualizar ubicaciones, conectar un asistente de IA) para poder elegir los permisos mínimos.

Pasos

  1. Abra Otros → API.
  2. En Claves de API, haga clic en Crear clave.
  3. Introduzca un Nombre claro que indique dónde se usa la clave, por ejemplo Production · backend.
  4. Marque los Permisos que necesita la integración. Elija los menos posibles. Para conectar un asistente de IA a través del servidor MCP, incluya mcp:connect.
  5. Haga clic en Crear clave en el cuadro de diálogo.
  6. La ventana Guarde su token muestra el token completo. Es la única vez que se muestra. Cópielo y guárdelo en un lugar seguro, como su gestor de contraseñas o el almacén de secretos de su servidor.
  7. Haga clic en Listo.

Importante: Trate el token como una contraseña. Nunca lo ponga en código de un sitio web que se ejecute en los navegadores de los visitantes ni lo comparta por correo electrónico o chat.

Compruebe que ha funcionado

Haga una solicitud de prueba con el token; el bloque Inicio rápido de la pantalla API muestra un ejemplo:

curl https://<your cabinet address>/api/v1/locations \
  -H "Authorization: Bearer <your token>"

Una respuesta correcta devuelve sus ubicaciones. En la pantalla API, la fecha de Último uso de la clave se actualiza y la llamada aparece en Registros de solicitudes.

Rotar o revocar una clave

  • Si el token puede haberse filtrado, o como medida de higiene habitual, use Rotar en la fila de la clave. Se muestra un token nuevo una sola vez; el anterior deja de funcionar de inmediato: actualice todas las integraciones que lo usan.
  • Si ya no necesita la clave, use Revocar. Las llamadas con ella fallan de inmediato. Esta acción no se puede deshacer.

Solución de problemas

  • «El nombre de la clave es obligatorio» / «Elija al menos un permiso». Rellene el nombre y marque al menos un permiso.
  • Las solicitudes devuelven 401. El token es incorrecto, está incompleto, revocado o rotado. Revise el encabezado Authorization: Bearer ….
  • Las solicitudes devuelven 403. A la clave le falta un permiso que requiere el endpoint. La referencia de la API indica los permisos necesarios para cada endpoint; cree una clave con los permisos adecuados.
  • Las solicitudes devuelven 429. Ha superado el límite por minuto. Espere el tiempo indicado en el encabezado Retry-After.
  • He perdido el token. No se puede volver a mostrar. Rote la clave para obtener un token nuevo.

Relacionado