Cree una API personalizada sencilla en Jitterbit API Manager
Introducción
Esta página está destinada a los nuevos usuarios de API Manager y demuestra cómo crear y publicar manualmente una API personalizada mediante Integration Studio operación.
Para crear y publicar una API participando en un diálogo escrito interactivo con un chatbot de IA, consulte Jitterbit AI Bot (Beta) para Jitterbit API Manager.
Para obtener una guía completa y un tutorial paso a paso, inscríbase en Creación y gestión de API curso sobre Jitterbit University.
Para obtener información sobre la configuración de un tipo específico de API, consulte estos recursos:
Prerrequisitos
Antes de crear una API personalizada, debe ser miembro de una organización de Harmony con una suscripción a API Manager y debe tener los permisos de organización y los niveles de acceso al ambiente adecuados, como se describe en Permisos y acceso de Harmony.
Cree una API con API Manager
Siga estos pasos para crear una API personalizada con API Manager:
Paso 1: Crear e desplegar la operación
Como se describe en Requisitos previos de API personalizada, un Integration Studio o Design Studio La operación primero debe crearse e desplegarse en el mismo ambiente en el que desea crear una API personalizada.
En este ejemplo de Integration Studio, la operación implementada consulta una base de datos y procesa los datos en una salida CSV:
Para obtener instrucciones sobre cómo crear e desplegar una operación en Integration Studio o Design Studio, consulte estos recursos:
- Integration Studio
- Design Studio
Paso 2: Configurar la API
Una vez implementada la operación de Integration Studio o Design Studio, navegue a la página de APIs en el API Manager y haga clic en Nuevo > API personalizada:
Al hacer clic en API personalizada, se abre la pantalla de configuración de Ajustes de la API. Complete cada campo con estos ajustes:
Una vez completados los campos anteriores, haga clic en Siguiente.
Nota
Para obtener información sobre cada campo en esta pantalla de configuración, consulte Paso 1: Configuración en Configuración de API personalizada.
Dado que se está creando una API personalizada, se ha seleccionado API personalizada como Tipo de servicio. La operación de Integration Studio del Paso 1: Crear e desplegar la operación está asignado al servicio API GET:
Una vez completados los campos anteriores y asignada la operación, haga clic en Guardar y luego en Siguiente.
Nota
La operación utilizada para el propósito de esta guía tiene una Actividad de respuesta de API configurado como el objetivo de la operación (consulte Paso 1: Crear e desplegar la operación). Como resultado, el Tipo de Respuesta se establece en Objetivo Final.
Para obtener más información sobre los campos Proyectos, Operación, Método y Tipo de Respuesta, consulte el Paso 2: Seleccionar el tipo de servicio y asignar operaciones en Configuración de API personalizada.
En la siguiente pantalla, se asignan los roles de usuario y los perfiles de seguridad adecuados a la API personalizada:
Los roles a elegir son los definidos en la pestaña Roles de la página Administración de usuarios para obtener más información sobre la asignación de roles de usuario, consulte el Paso 3: Asignar roles de usuario y perfiles de seguridad en Configuración de API personalizada.
Para obtener más información sobre los perfiles de seguridad, consulte estos recursos:
Al hacer clic en Siguiente, llegará a la página Resumen y confirmación:
Al hacer clic en Guardar y Publicar, un cuadro de diálogo indica que la API está activa:
Haz clic en Copiar URL. La URL copiada se usará en el Paso 3: Probar la API.
Paso 3: Probar la API
Para probar la API, pegue la URL de la API del Paso 2: Configurar la API en un navegador web:
Una vez autenticado, la operación de Integration Studio desde Paso 1: Crear e desplegar la operación se activa y responde con un archivo CSV de la lista de clientes de la empresa de ejemplo:
Próximos pasos
Una vez que la API esté activa, puede API generando documentación de API en el Administrador del portal página, ver los registros en Registros de API o revisar las métricas de consumo y rendimiento de la API en Analytics página.
Para obtener información adicional sobre API Manager, consulte estos recursos: