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 Configuración de API personalizada y Configuración de API proxy.

Alternativamente, cree APIs OData utilizando el Asistente AI de APIM.

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 en el proyecto de Design Studio asociado con la API OData.

Requisitos previos

Una API OData expone una operación de entidad API de Jitterbit iPaaS para su consumo. Debe primero 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 API de Design Studio.

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

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

Crear una nueva API OData

Para crear una nueva API OData, haz clic en Nuevo y selecciona una de las siguientes opciones:

• Construir con IA: Abre el Asistente de APIM para crear una API utilizando indicaciones en lenguaje natural. Para más información, consulta Usando el Asistente de IA.

  Nota

  Para usar el Asistente de IA de APIM, tu licencia de Harmony debe incluir la opción de Asistente de IA de APIM. Contacta a tu Gerente de Éxito del Cliente (CSM) para agregar esta opción a tu licencia.

• API OData: Abre la pantalla de configuración de la API OData para crear manualmente una nueva API OData. Esta opción está habilitada solo si hay una URL de API correspondiente disponible.

Configurar una API OData

Cuando configuras una API OData manualmente, la pantalla de configuración incluye múltiples pestañas. La pantalla de configuración incluye dos pestañas obligatorias y tres pestañas opcionales:

• 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 usar caracteres especiales distintos de un guion bajo (_). Se permiten los siguientes caracteres especiales: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -.

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

• Entorno: Usa 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 las siguientes opciones 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 tanto solicitudes 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 de las solicitudes y las cargas útiles 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. Utilice 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 activadas 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 Gestió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.

• Mostrar cargas útiles de solicitud y respuesta en los registros: Habilite este interruptor para capturar y mostrar las cargas útiles de solicitud y respuesta en la página API Logs cuando se realiza una solicitud a la API. Este interruptor se aplica solo a APIs personalizadas y OData.

  Advertencia

  Las cargas útiles de solicitud y respuesta pueden incluir datos sensibles como credenciales de autenticación o información personal identificable. Utilice esta configuración con cuidado.

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

Pestaña de Servicios

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

Haz clic en Nuevo Servicio para agregar un nuevo servicio de API. Configura los siguientes ajustes para cada servicio:

• Entidad: Selecciona de los proyectos desplegados que contienen una operación de entidad de API en el entorno donde estás 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: Selecciona de las operaciones de entidad de API de Design Studio desplegadas en la entidad seleccionada. Solo se puede asignar una operación utilizando cada método.

  Para obtener información sobre lo que aparece en los registros de operaciones para operaciones activadas por API y cómo habilitar registros adicionales, consulta Datos de solicitud y respuesta de API en Registros de operaciones.

• Método: Selecciona 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, ingresa el nombre del método en el cuadro de texto Escribe un nuevo método y presiona Enter.

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

  • Copiar URL del servicio de API: Haz clic para copiar la URL del servicio de la API.
  • Ir al Servicio de API: Haz clic para ver una descripción general en una sola página de la configuración de la API OData.
  • Duplicar: Haz clic para duplicar el servicio de API.
  • Eliminar: Haz clic para eliminar el servicio de 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 continuar 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ásica, OAuth 2.0 o Clave API.

• Nombre de Usuario: Para la autenticación básica, se muestra el nombre de usuario. Para otros tipos de autenticación, se 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 de Harmony, es posible 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 de Perfiles de seguridad, haz clic en Siguiente para proceder a la pestaña de Roles de usuario, o haz clic en Anterior para regresar a la pestaña de Servicios.

Pestaña de Roles de usuario

La pestaña de 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 de 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, incluyendo 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 perfiles de seguridad.

Cualquier rol de usuario definido con el permiso Administrador siempre tiene acceso completo a todas las APIs y, por lo tanto, no se puede deseleccionar.

Haz clic en Nuevo rol de usuario para crear un nuevo rol de usuario. Para instrucciones, consulta Roles en Gestión de usuarios.

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

Opciones de guardar y publicar

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

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

• Publicar: Guarda la API en estado de Publicado. La API está activa y accesible en cinco minutos. Una API publicada cuenta contra tu 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 tu portapapeles.
  • Generar documento OpenAPI: Abre la página del Portal Manager. Para generar documentación para APIs individuales, utiliza la pestaña de Documentación al editar la API desde la página de APIs.
  • Cerrar: Cierra el diálogo.

Parámetros de consulta OData

Puedes filtrar los datos devueltos añadiendo parámetros de consulta OData a una URL de servicio de 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 tarjeta en la página de APIs, haz clic en la tarjeta.
• Usando vista de lista en la página de APIs, haz clic en Editar en la columna Acciones.

Al editar una API publicada desde la vista de lista, también está disponible una pestaña de Documentación. Usa esta pestaña para ver, editar y publicar documentación OpenAPI para APIs individuales. Para más detalles, consulta la pestaña de Documentación en la página de APIs.