APIs Gestionadas
Cómo definir respuestas de error personalizadas
Resumen Así como puedes definir formatos y plantillas para las respuestas exitosas de la solicitud al método, puedes definir plantillas de error para cada formato que hayas agregado y para cada tipo de error conocido. Configurar plantillas de error ...
Cómo configurar Variables de contexto
Resumen Las variables de contexto permiten asociar valores asignados a la cuenta, usuarios y aplicaciones a valores de parámetros de los métodos de las APIs. Al configurar el método de la API puedes releacionar sus parámetros a variables de contexto. ...
Cómo agregar diccionarios de datos
Resumen Los diccionarios de datos permiten mejorar la documentación de los métodos de las APIs y además agregan capacidades extendidas sobre ellos. Configurar diccionarios de datos Para configurar el diccionario de datos de un método, debe acceder al ...
Publicar versiones de API
Resumen Una API puede tener una o más versiones. Podrás publicar y gestionar de forma aislada cada versión. Aquí se explica el flujo de publicación de las versiones de las APIs. Publicar versión Una vez que hayas creado una API, una versión y ...
Crear métodos de APIs
Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...
Cómo compartir métodos privados a usuarios registrados
Resumen Cuando haya definido sus métodos con visibilidad Privado, deberá compartilo con los usuarios desarrolladores registrados que deban tener acceso al método. Compartir acceso Los métodos pueden estar protegidos por API Keys o mediante el ...
Configurar privacidad de APIs y métodos
Resumen Puedes definir la privacidad de tus APIs y métodos para otorgar acceso solo a los usuarios que desees, o revocar los accesos cuando lo requieras. Reglas de privacidad Puedes configurar la visibilidad de las APIs y los métodos, es decir, si ...
Cómo definir las rutas a los métodos: buenas prácticas
Resumen La definición de rutas o paths debe ser consistente con los recursos o entidades a los que refiere el método. A continuación se indican ciertas buenas prácticas para considerar en la definición de rutas. Un repaso Antes de continuar, ...
Qué son los tipos de solicitud de los métodos
Resumen Los métodos de APIs requieren la definición de un tipo de solicitud. Sugerimos que respete los estádares REST/json al crear sus métodos, en base a las siguientes definiciones. Tipos de petición o solicitud Los métodos más utilizados en las ...
Crear y gestionar versiones de APIs
Resumen Una API puede tener una o más versiones. Cada versión contiene los métodos de la API, y puede tener múltiples versiones publicadas al mismo tiempo. Considere agregar nuevas versiones de APIs cuando los cambios que realice impacten en las ...
Crear y configurar API
Resumen Las APIs serán expuestas en el portal para desarrolladores. Una API puede contener múltiples versiones, y cada una de las versiones mútiples métodos. Para crear una API debe ir a APIs > Nueva API. Configurar API Al crear una nueva API deberá ...
Cómo definir formatos de respuesta de los métodos
Resumen Los formatos de salida permiten definir uno o más formatos de respuesta en los métodos de su API. Los formatos de salida pueden ser mútiples en formato JSON, aunque también puede exponer los datos en CSV y XML. Configurar formatos Al crear un ...
Popular Articles
Qué son los orígenes de datos
Resumen Los orígenes de datos son el punto de partida del flujo de los datos, a partir de los cuales se crearán vistas de datos y métodos de APIs. A continuación se detallan las caraceterísticas de los orígenes de datos. Algunos conceptos básicos ...
Roles de usuario
Resumen Vor-Tex utiliza la asignación de roles de usuarios con el fin de que los administradores de la cuenta tengan la capacidad de controlar lo que los usuarios pueden y no pueden hacer. Resumen de roles: Propietario: es el propietario de la ...
Personalización de dominios
Resumen Por defecto, la plataforma ofrece dominios bajo *.vor-tex.io, aunque puede utilizar dominios propios. Configurar dominios Para configurar los dominios de su Portal del desarrollador y entornos del API Gateway, el adminsitrador de su dominio ...
Qué son los recursos de datos: ciclo de vida y flujo de publicación
Resumen Los recursos de datos de la plataforma son aquellos que permiten recolectar, transformar y exponer datos. La plataforma cuenta con tres recursos de datos: Orígenes de datos, Vistas de datos y APIs. Orígenes de Datos: mediante los orígenes de ...
Agregar filtros y parámetros en la vista de datos
Resumen Las vistas de datos permiten agregar filtros fijos o dinámicos, estos últimos llamadados parámetros. Filtros fijos Para agregar un filtro debes hacer clic en la opción Filtrar datos. Se mostrará una formulario donde deberás seleccionar la ...