Skip to main content

Creación y Edición de API

En esta sección se explicará el proceso para crear y editar APIs en OliveScan, siguiendo un flujo claro y estructurado para garantizar la correcta configuración de las integraciones.

Formulario de creación y edición de APIs​

El formulario para crear o editar APIs en OliveScan está dividido en varias secciones principales:

1. Datos generales de la API​

  • Nombre: Obligatorio, máximo 50 caracteres.
  • API Key: Obligatorio, clave única proporcionada por el cliente o generada internamente.
  • Secret Key: Obligatorio, clave secreta asociada a la API.
  • Activo: Opción para activar o desactivar la API.

2. Gestión de clientes​

La gestión de clientes asociados a la API sigue un flujo secuencial que permite asignar estas entidades de manera eficiente:

  1. Selección de clientes disponibles:

    • Utilice el buscador para filtrar clientes disponibles.
    • Seleccione uno o más clientes que desea asociar a la API.
    • Presione el botón >> para moverlos a la lista de clientes asignados.

  2. Gestión de clientes asignados:

    • Utilice el buscador para filtrar clientes ya asignados.
    • Seleccione uno o más clientes que desea desasignar de la API.
    • Presione el botón << para moverlos a la lista de clientes disponibles.

3. Validaciones principales​

  • Todos los campos obligatorios deben estar completos y cumplir con las restricciones de formato.
  • Las claves deben ser únicas y válidas.
  • Los clientes asignados deben estar correctamente seleccionados.
tip

Si algún campo no cumple con las validaciones, el formulario mostrará un mensaje de error específico debajo del campo correspondiente.

4. Guardado y edición​

Al guardar, el sistema crea o actualiza la API según el modo seleccionado. Si la operación es exitosa, se muestra una confirmación; en caso de error, se muestra una alerta con el motivo.

tip

Es importante validar los datos ingresados antes de guardar para evitar errores en la configuración de las integraciones.