Gestiona tus APIs ya construidas
Resumen
En este artículo encontrarás como utilizar la plataforma para gestionar tus APIs REST/json ya construidas y utilizar las capacidades de seguridad, estadísticas, auditoría, monitoreo y otras que ofrece la plataforma.
Para poder seguir estos pasos necesitas:
- Un endpoint de una API REST/json y sus parámetros, cabeceras y esquema de autenticación o autorización que requiera el servicio.
Ejemplo
En este artículo utilizaremos un ejemplo sencillo de API REST/json.
Es una solicitud GET con varios parámetros:
La respuesta a esa solicitud es:
{
"meta": {
"count": 1
},
"data": [
{
"employeeId": 10001,
"birthDate": "2/9/1953",
"firstName": "Georgi",
"lastName": "Facello",
"gender": "M",
"hireDate": "26/6/1986"
}
]
}
Video
Encapsular API ya construida
Configurar origen de datos
Para configurar el origen de datos debes ir a Workspace > Origenes de datos > Desde servicios web y seleccionar la pestaña REST/JSON.
Ingresa el endpoint y todas las configuraciones requeridas por tu API REST o servicio web, prueba la conexión y guarda el origen de datos.
En el ejemplo utilizado, ingresaremos el endpoint y luego cada uno de los parámetros, defiendo cuáles serán editables y cuáles no. Sobre los parámetros editables podrás definir reglas de validación y asociarlos a variables de contexto.
Si además de exponer el resultado sin transformaciones, quieres exponer otras salidas de la API con tranformaciones y diferentes formatos, deberas ingresar la Ruta a los datos y Previsualizar la configuración para comprobar que la tabulación de datos sea correcta.
Para más información sobre las configuraciones de un origen REST/json accede a este artículo.
Continúa con la creación de la vista de datos.
Al configurar el método de la API podrás seleccionar el formato RAW que permite entregar la misma respuesta que tu servicio, sin aplicar transformaciones.
Seleccionar, transformar tus datos y configurar validaciones de parámetros (opcional)
Al crear la vista de datos podrás seleccionar los datos que deseas exponer en el método de la API, agregar nuevos filtros de datos, formatear los datos y aplicar agrupaciones, cómputos y cálculos.
Además, puedes agregar validaciones sobre los parámetros editables o mapeos que hayas aplicado al configurar el origen de datos.
Para más información accede a esta sección.
Configurar API, versión y método
Crear API
Para crear una API debes ir a APIs > Nueva API.
Ingresa un nombre y descripción, selecciona un ícono y una categoría.
Define los SLO
Define los límites,tiempo máximo de respuesta, caché y cantidad máxima de filas. Luego, guarda tu API.
Crear version
Una vez que hayas creado la API, crea una versión.
Agregar métodos
Ahora puedes agregar un método a la versión de tu API. Al agregar el método deberás seleccionar la vista de datos, configurar el tipo de solicitud y ruta, agregar una descripción, diccionarios de datos y otras configuraciones.
Puedes definir múltiples formatos de salida para el método de tu API. Además, puedes seleccionar el formato RAW que no realizará transformaciones sobre la respuesta que entregue el origen de datos.
Puedes además definir la privacidad de tu método.
Para más información accede a esta sección.
Publicar API
Publica la versión de tu API para que esté disponible en el portal para desarrolladores y pueda comenzar a ser ejecutada.
Compartir acceso a los métodos
Si definiste métodos privados, deberás compartirlos con los usuarios que correspondan para que puedan acceder a la documentación en el portal y puedan comenzar a utilizarlos.
Portal para desarrolladores
Probar API publicada
Una vez que hayas publicado la versión de tu API, ingresa al portal y prueba los métodos para validar que funciona como esperas.
Para más información accede a esta sección.
Gestionar API
Control de cambios
Si realizas alguna modificación en los recursos del Workspace (Orígenes de datos, vistas o APIs) se generarán versiones en borrador que debes publicar para que los cambios aplicados impacten sobre el portal y gateway. Para más información accede a este artículo.
Gestión de entornos
Si deseas configurar diferentes entornos para los métodos de tus APIs puedes hacerlo al configurar la vista de datos. Conoce cómo configurar el multi-entorno.
Versionado
Puedes agregar nuevas versiones a tu API a medida que lo necesites. También puedes despublicar las versiones antiguas si quieres deperecarlas.
Panel de estadísticas
En
Workspace puedes acceder a la sección de Estadísticas para conocer el
consumo de las APIs por códigos de respuesta, usuarios y APIs en un
período de tiempo, mediante gráficos. Continua leyendo para conocer cómo consultar estos datos mediante APIs.
APIs Adminstrativas
Las APIs administrativas te permitirán conocer las estadísticas, documentos de auditoría y niveles de servicio de tus APIs. Conoce más en esta sección.
Estadísticas
Si quieres integrar los datos de estadísticas a tus sistemas o programas de visualizaciones puedes utilizar la API de Estadísticas, disponible en el portal de APIs Administrativas.
Auditoría
Puedes conocer el detalle de las solicitudes recibidas y respuestas entregadas mediante la API de auditoría disponible en el portal de APIs Administrativas.
Monitoreo
Si tu cuenta tiene habilitado el monitoreo de los métodos, puedes conocer sus niveles de disponibilidad mediante la API de monitero en el portal de APIs Administrativas.
Related Articles
Crear una cuenta de Vor-Tex
Para registrarte en Vor-Tex debes ingresar a https://workspace.vor-tex.io/signup/ Primero deberás ingresar tu email. Luego, recibirás este mensaje y un email en la dirección ingresada con un enlace para continuar el proceso de registro. Al acceder al ...Construye y publica una API desde cero
Resumen En este artículo encontrarás como utilizar la plataforma para construir, publicar y gestionar tu primera API. Para poder seguir estos pasos necesitas un origen de datos. Si no, puedes utilizar este ejemplo. Ejemplo En este artículo ...