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.