Saltar al contenido

Configuración de la Autenticación Mediante Clave API

App Builder las APIs REST se pueden proteger mediante claves API. La configuración de la autenticación mediante clave API implica los siguientes procedimientos:

  1. Creación an App Builder proveedor de seguridad.
  2. Generar una clave API.

Requisitos

Para continuar, necesitarás:

  • Acceso de administrador a App Builder.
  • API REST para pruebas.

Creando an App Builder proveedor de Seguridad

  1. La autenticación con clave API está habilitada dentro App Builder a través de un proveedor de seguridad. Comience iniciando sesión en App Builder como administrador.
  2. Navegue hasta el IDE
  3. Haga clic en el botón Proveedores de seguridad
  4. En el panel Autenticación de usuario, haga clic en el botón + Autenticación de usuario

  5. Proporcione lo siguiente:

    • Nombre: Clave API
    • Tipo: Clave API
    • Activo: Marcado
    • Prioridad: un número entero entre 10 y 100 (por ejemplo, 50). Tenga en cuenta que este valor debe ser único.

  6. Haga clic en el botón Guardar

Generar una Clave API

Las claves API están asociadas con App Builder usuarios. Para generar una nueva clave API, comience iniciando sesión en App Builder como administrador.

  1. Navegue hasta el IDE
  2. Haga clic en el botón Administración de usuarios
  3. En el panel Usuarios, busque el usuario para el que desea generar una clave API
  4. Haga clic en el ícono Abrir registro (ventana emergente)
  5. Haga clic en el ícono Teclas (Tecla)
  6. Haga clic en el botón Crear

  7. Proporcione lo siguiente:

    • Proveedor: Clave API
    • Descripción: Descripción del propósito de la clave. Por ejemplo: proporciona acceso a la API REST

    • Caducidad en: duración de la clave API en minutos. Una vez generada, la duración no se puede modificar.

      API_expire.png

  8. Haga clic en el botón Guardar

Tenga en cuenta la clave API generada. Tendrá la forma de un entero de 128 bits codificado en base64url. Ejemplo: DLOo9sPS5slJEMHpXBFt3g

Probando la Clave API

A continuación se demuestra cómo autenticar una solicitud de API REST utilizando una clave API.

GET /rest/v1/sales/customers HTTP/1.1
Host: example.com:443
Accept: application/json
X-API-Key: DLOo9sPS5slJEMHpXBFt3g