Saltar al contenido

¡Transforma tus conexiones en dinero para el final del año con nuestro nuevo Programa de Indicación de Clientes! Descubre más

Esta documentación es para la versión 4 y posteriores de App Builder, el nuevo nombre de Vinyl. Accede a la documentación de Vinyl aquí.

Configuración de la autenticación de clave API en Jitterbit App Builder

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

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

Requisitos

Para continuar, necesitarás:

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

Creación de un proveedor de seguridad de App Builder

  1. La autenticación con clave API se habilita en App Builder mediante un proveedor de seguridad. Para empezar, inicie 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 (p. ej., 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 a los usuarios de App Builder. Para generar una nueva clave API, inicie 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, localice 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: Duración de la clave API en minutos. Una vez generada, esta duración no se puede modificar.

      API_expire.png

  8. Haga clic en el botón Guardar

Anote la clave API generada. Será un entero de 128 bits codificado en base64. 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