Configuración de la Autenticación de Clave API¶

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

Creación de un proveedor de seguridad de Vinyl.
Generar una clave API.

Requisitos¶

Para continuar, necesitará:

Acceso de administrador a Vinyl.
API REST para pruebas.

Crear un Proveedor de Seguridad de Vinyl¶

La autenticación de clave API se habilita dentro de Vinyl a través de un proveedor de seguridad. Comience iniciando sesión en Vinyl como administrador.
Navegue hasta IDE
Haga clic en el botón Proveedores de seguridad
En el panel Autenticación de usuario, haga clic en el botón + Autenticación de usuario
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.
Haga clic en el botón Guardar

Generando una Clave API¶

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

Navegue hasta IDE
Haga clic en el botón Administración de usuarios
En el panel Usuarios, localice el usuario para el que desea generar una clave API.
Haga clic en el icono Abrir registro (ventana emergente)
Haga clic en el ícono Claves (Clave)
Haga clic en el botón Crear.
Proporcione lo siguiente:
- Proveedor: Clave API
- Descripción: Descripción del propósito clave. Por ejemplo: proporciona acceso a la API REST
- Expira en: Duración de la clave API en minutos. Una vez generada, la vida útil no se puede cambiar.
Haga clic en el botón Guardar

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

Probando la Clave API¶

A continuación se muestra 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