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á completar el Título, la Descripción y seleccionar un ícono.
El título de su API será parte de la ruta o URL de consulta a su API.
Por ejemplo, si el título de su API es "Indicadores diarios" la ruta será: "
https://api.dominio.com/
indicadores-diarios/v1/metodo.json"
Además deberá definir la visibilidad de su API, es decir, si será Pública o Privada.
Puede ingresar de manera opcional Notas para mostrar una descripción extendida de la API en el portal para desarrolladores.
SLO
Los SLO (Objetivos de Niveles de Servicio) permiten aplicar la configuración de monitoreo de los métodos y brindar información contextual a los usuarios desarrolladores.
Límites
Los límites permiten definir la cantidad de consultas y transferencias máximas en MB que aceptará la APIs por unidades de tiempo.Estos límites podrán ser sobreescritos a nível de cada uno de sus métodos.
Estos límites permiten evitar usos incorrectos que degraden el servicio y su definición dependerá del tipo de API, del perfil de usuarios desarrolladores y del problema que se busca resolver.
Además, podrá definir los tiempos de espera (timeout) y el tiempo que la respuesta permanecerá en caché. La configuración de caché es relevante para mejorar la performance de la respuesta y su definición dependerá de la frecuencia de actualización de los datos.
Por último, es posible definir en Ancho de banda por aplicación, para distribuir los límites entre las aplicaciones de los desarrolladores. Esto permite evitar que una aplicación de un desarrollador consuma todos los límites establecidos, y en su lugar que estos límites sean distribuidos entre desarrolladores.
Cuando se superen los límites establecidos la API responderá con un mensaje indicando que se han superado los límites y el tiempo de espera o cuarentena. Esto se conoce como
request throttling limits.
Una vez creada su API verá la ficha de la API con las configuraciones realizadas. Ahora deberá crear su primera versión.
Related Articles
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 ...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 crear una aplicación
Resumen La aplicación obtiene las credenciales que le permiten identificarse al consumir las APIs. Crear una aplicación Para crear una aplicación debe estar registrado y autenticado en el portal. Una vez autenticado, haga clic en Crear aplicación. ...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. ...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 ...