Configuración de la API OData en Jitterbit API Manager

Introducción

Esta página describe cómo crear y configurar una API OData desde la página de APIs de Jitterbit API Manager. Una API OData es uno de los tres tipos de APIs configurados a través del API Manager. Para los otros dos tipos, API personalizada y API proxy, consulte la configuración de API personalizada y la configuración de API proxy.

Las APIs OData (publicadas y en borrador) se muestran en estas ubicaciones:

• La página de APIs del API Manager.
• La pestaña Recursos del panel del proyecto para el proyecto de Design Studio asociado con la API OData.

Requisitos previos

Una API OData expone una operación de entidad de API de Jitterbit iPaaS para su consumo. Primero debe crear y desplegar esta operación antes de poder configurar la API OData. La operación que activa una API OData debe ser una operación de entidad de API de Design Studio.

Para obtener información sobre cómo crear y desplegar una operación de entidad de API en Design Studio, consulte estos recursos:

• Guía de inicio rápido de Design Studio
• Crear una entidad de Jitterbit
• Crear una operación de entidad de API

Crear una nueva API OData

Cuando accede a la página de APIs del API Manager, si no existen APIs personalizadas, APIs OData o APIs proxy en la organización seleccionada, esta pantalla está en blanco.

Para crear una nueva API OData, haz clic en Nuevo > API OData.

Configurar una API OData

La pantalla de configuración incluye múltiples pestañas, con dos pestañas obligatorias y tres pestañas opcionales. Cada pestaña se cubre en las siguientes secciones:

• Pestaña de perfil (obligatoria)
• Pestaña de configuración (opcional)
• Pestaña de servicios (obligatoria)
• Pestaña de perfiles de seguridad (opcional)
• Pestaña de roles de usuario (opcional)

Pestaña de perfil

Utiliza la pestaña Perfil para ingresar información básica que identifique la API.

Configura los siguientes ajustes:

• Nombre de la API: Ingresa un nombre para la API que se utilizará con fines de identificación interna. Se permiten los siguientes caracteres especiales: ( ) - _.

• Raíz del servicio: El nombre público de la API que se utilizará como parte de la URL del servicio de la API. Por defecto, este campo se completa con el Nombre de la API convertido a camel case. Este campo no permite espacios ni ciertos caracteres especiales. No se recomienda el uso de caracteres especiales distintos de un guion bajo (_). Se permiten los siguientes caracteres especiales: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -.

• Descripción: Ingresa una descripción opcional para la API.

• Entorno: Utiliza el menú para seleccionar el entorno donde residirá la API. Puedes escribir cualquier parte del nombre del entorno en el menú para filtrar la lista de entornos. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

  Nota

  Después de la creación de la API, no puedes cambiar el entorno. Para mover una API entre entornos, puedes clonar la API o exportar e importar la API en otro entorno.

• Número de versión: Ingresa una versión opcional para usar como parte de la URL del servicio de la API. Este campo permite un máximo de 48 caracteres y no permite espacios ni ciertos caracteres especiales. No se recomienda usar caracteres especiales distintos de un punto (.) o un guion (-). Las convenciones de nomenclatura comunes incluyen versiones incrementales como v1.0, v1.1, v1.2, o usar una fecha en la que se publicó la API, como 2025-08-28.

Después de completar la pestaña Perfil, haz clic en Siguiente para proceder a la pestaña Configuración, o haz clic en Guardar como borrador para guardar tu progreso.

Pestaña de Configuración

La pestaña Configuración es opcional y contiene opciones de configuración avanzadas para la API.

Configura los siguientes ajustes según sea necesario:

• Tiempo de espera: Ingresa el número de segundos antes de que la API se agote. El valor predeterminado es de 30 segundos. El valor máximo permitido es 180 segundos.

  Nota

  Esta configuración es independiente de la configuración de tiempo de espera de operación en Studio o Design Studio. Las configuraciones de tiempo de espera de operación no se utilizan a menos que se use un agente privado y la configuración EnableAPITimeout en el archivo de configuración del agente privado esté habilitada.

• Solo SSL: Este interruptor está habilitado por defecto y requiere HTTPS para la API. Cuando está habilitado, los datos se cifran a través de SSL, y una solicitud HTTP devuelve un error. Cuando está deshabilitado, se admiten solicitudes tanto HTTP como HTTPS.

  Advertencia

  Cuando está deshabilitado, los datos transmitidos a través de las solicitudes y respuestas de la API no están encriptados y pueden ser interceptados y vistos por otros. Esto podría potencialmente exponer información sensible.

• CORS: Habilite este interruptor para soportar CORS (Intercambio de Recursos de Origen Cruzado). CORS es un mecanismo que permite a las aplicaciones web que se ejecutan en un navegador web en un dominio acceder a recursos de un servidor en un dominio diferente.

  Advertencia

  Habilitar CORS hace que las operaciones que utilizan el método OPTIONS se ejecuten sin autenticación.

• Registro detallado: Habilite este interruptor para registrar los encabezados y cargas útiles de las solicitudes cuando se realiza una solicitud a la API.

  Advertencia

  El registro detallado puede incluir datos sensibles como credenciales de autenticación o información personal identificable. Use esta configuración con cuidado.

• Habilitar modo de depuración hasta: Habilite este interruptor para activar el registro detallado para la solución de problemas, luego haga clic en el ícono del calendario para seleccionar una fecha hasta dos semanas a partir de hoy cuando el modo de depuración se apague automáticamente. Cuando habilita el modo de depuración para operaciones desencadenadas por esta API, los registros de la API incluyen datos de solicitud y respuesta (conservados durante 30 días) a los que puede acceder a través de la página Runtime de la Consola de Administración. Por defecto, el Administrador de API solo registra operaciones de API con errores.

  Advertencia

  Los registros de depuración contienen todos los datos de solicitud y respuesta, incluida información sensible como contraseñas e información personal identificable (PII). Estos datos aparecen en texto claro en los registros de la nube de Harmony durante 30 días.

Después de configurar la pestaña Configuraciones, haga clic en Siguiente para proceder a la pestaña Servicios, o haga clic en Anterior para regresar a la pestaña Perfil.

Pestaña Servicios

La pestaña Servicios es donde se configuran los servicios de la API que definen cómo responde la API a las solicitudes. Para las APIs OData, asigna operaciones de entidad de Jitterbit que exponen datos a través del protocolo OData.

Haga clic en Nuevo Servicio para agregar un nuevo servicio API. Configure los siguientes ajustes para cada servicio:

• Entidad: Seleccione de los proyectos desplegados que contienen una operación de entidad API en el entorno donde está configurando la API. El nombre de la entidad corresponde al nombre del proyecto en Design Studio.

• Proyecto: Muestra el nombre del proyecto de Design Studio que contiene la entidad seleccionada.

• Operación: Seleccione de las operaciones de entidad API de Design Studio desplegadas en la entidad seleccionada. Solo se puede asignar una operación utilizando cada método.

  Importante

  De forma predeterminada, las operaciones exitosas configuradas para una API OData no se incluyen en los registros de operaciones a menos que se habilite una de estas configuraciones:

  • Agentes en la nube: Para operaciones API en un agente en la nube, se debe habilitar el registro de depuración de operaciones en la operación.
  • Agentes privados: Para operaciones API en un agente privado, se debe habilitar el registro de depuración de operaciones en la operación o debe establecer EnableLogging=true en la sección [APIOperation] del archivo de configuración del agente privado.

  Las operaciones no exitosas se incluyen en los registros de operaciones independientemente de si las configuraciones anteriores están habilitadas o no.

• Método: Seleccione el método HTTP que se creará para la operación seleccionada. Los métodos disponibles incluyen GET, PUT, POST, DELETE, PATCH, MERGE o ALL. Seleccionar ALL crea métodos separados GET, PUT, POST, DELETE, PATCH y MERGE para la operación seleccionada. Para usar un método que no esté listado, ingrese el nombre del método en el cuadro de texto Escriba un nuevo método y presione Enter.

• Acciones: Pasa el cursor sobre una fila de servicio para revelar acciones adicionales.

  • Copiar URL del servicio API: Haz clic para copiar la URL del servicio API.
  • Ir al servicio API: Haz clic para ver un resumen en una sola página de la configuración de la API OData.
  • Duplicar: Haz clic para duplicar el servicio API.
  • Eliminar: Haz clic para eliminar el servicio API.

Puedes configurar múltiples servicios para una sola API OData. Debes agregar al menos una entidad para proceder a la siguiente pestaña.

Después de configurar la pestaña Servicios, haz clic en Siguiente para proceder a la pestaña de perfiles de seguridad, o haz clic en Anterior para regresar a la pestaña de configuración.

Pestaña de perfiles de seguridad

La pestaña Perfiles de seguridad es opcional y te permite restringir el acceso para el consumo de la API.

Configura los siguientes ajustes:

• Asignar: Usa el interruptor para asignar o desasignar perfiles de seguridad para la API.

• Nombre del perfil: El nombre del perfil de seguridad según lo configurado en Perfiles de seguridad.

• Tipo: El tipo de autenticación para el perfil de seguridad, como Básico, OAuth 2.0 o Clave API.

• Nombre de usuario: Para la autenticación básica, esto muestra el nombre de usuario. Para otros tipos de autenticación, esto muestra el mismo valor que la columna Tipo.

• Acciones: Pasa el cursor sobre una fila de perfil de seguridad para revelar acciones adicionales.

  • Ir al perfil de seguridad: Haz clic para abrir la configuración del perfil de seguridad.

Dependiendo de las políticas de la organización Harmony, puede que se requiera asignar un perfil de seguridad para poder guardar la API.

Haz clic en Nuevo perfil de seguridad para crear un nuevo perfil de seguridad. Para instrucciones, consulta Configurar perfiles de seguridad.

Después de configurar la pestaña Perfiles de seguridad, haz clic en Siguiente para proceder a la pestaña Roles de usuario, o haz clic en Anterior para regresar a la pestaña Servicios.

Pestaña Roles de usuario

La pestaña Roles de usuario es opcional y determina qué roles de organización tienen acceso a la API dentro del Administrador de API.

Configura los siguientes ajustes:

• Rol de usuario: El nombre del rol de organización según se define en la pestaña Roles de la página de Gestión de Usuarios.

• Permisos: Los permisos asignados a este rol, como Leer o Administrador.

• Estado: Indica si el rol está asignado a esta API. Cambia el estado para asignar o desasignar roles.

• Acciones: Pasa el cursor sobre una fila de rol de usuario para revelar acciones adicionales.

  • Ir al rol de usuario: Haz clic para abrir la configuración del rol de usuario.

Los roles que selecciones aquí determinan el acceso a esta API específica desde estas páginas:

• APIs
• Administrador del Portal, incluida la generación de documentación de API
• Portal de API
• Registros de API
• Analíticas

El acceso a la página de Perfiles de Seguridad y el acceso para consumir la API no se ven afectados por esta selección. El acceso para consumir una API está controlado por los perfiles de seguridad.

Cualquier rol de usuario definido con el permiso Admin siempre tiene acceso completo a todas las API y, por lo tanto, no se puede eliminar de la selección.

Haga clic en Nuevo rol de usuario para crear un nuevo rol de usuario. Para obtener instrucciones, consulte Roles en Gestión de usuarios.

Después de configurar la pestaña Roles de usuario, haga clic en Publicar para publicar la API, o haga clic en Guardar como borrador para guardar su progreso.

Opciones de guardar y publicar

Después de configurar todas las pestañas requeridas, puede guardar o publicar la API:

• Guardar como borrador: Guarda la API en estado Borrador o estado Publicado con Borrador. Las API en borrador no cuentan contra su límite de suscripción de URL de API. Una API cuyo estado fue Publicado en el momento en que utiliza Guardar como borrador se guarda como Publicado con Borrador. Una API publicada cuenta contra su límite de suscripción de URL de API, aunque su borrador no sea accesible.

• Publicar: Guarda la API en estado Publicado. La API está activa y accesible en cinco minutos. Una API publicada cuenta contra su límite de suscripción de URL de API. Un diálogo indica que la API está activa:

  

  El diálogo proporciona estas opciones:

  • Copiar URL: Copia la URL del servicio de la API en su portapapeles.
  • Generar documento OpenAPI: Abre la página del Administrador del Portal. Tenga en cuenta que solo puede generar documentación OpenAPI para API personalizadas, no para API OData.
  • Cerrar: Cierra el diálogo.

Parámetros de consulta OData

Puedes filtrar los datos que se devuelven agregando parámetros de consulta OData a una URL de servicio API OData. Los parámetros de consulta específicos admitidos dependen de la base de datos subyacente.

Los parámetros de consulta OData comunes incluyen:

https://jbexample.jitterbit.net/Sandbox/customers?$top=10&$orderby=name

Editar la API

Después de guardar la API, puedes editarla desde estas ubicaciones:

• Usando vista de mosaico en la página de APIs, haz clic en Ver/Editar.
• Usando vista de lista en la página de APIs, haz clic en Editar en la columna Acciones.