Crear y configurar API

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 Nivel de Servicio) declaran el tiempo de respuesta y la disponibilidad que se compromete para la API, y cada cuántos minutos se comprueba el estado de sus métodos. El paso 2. SLO aparece en las cuentas con monitoreo de métodos habilitado; cada método puede sobreescribir los valores de la API. Vea Definir el objetivo de nivel de servicio (SLO).
Paso 2. SLO del asistente de API

Límites

El paso Límites define las cuotas globales de la API, que heredan todos sus métodos y que pueden sobreescribirse en cada uno, para todos los usuarios o para grupos y usuarios específicos:
  • Cantidad de solicitudes admitidas por segundo, minuto, hora, día, mes y año.
  • Tiempo máximo de espera, en milisegundos: cuánto espera el gateway la respuesta del origen antes de devolver un error.
  • Duración de caché de la respuesta, en milisegundos: cuánto tiempo se reutiliza una respuesta sin volver a consultar el origen. Conviene ajustarla a la frecuencia de actualización de los datos.
  • Cantidad de MB admitidos por segundo, minuto, hora, día, mes y año.
  • Máximo de filas por página: el tope del parámetro limit cuando el método pagina.
Estos límites evitan usos que degraden el servicio; su definición depende del tipo de API, del perfil de los desarrolladores y del problema que se busca resolver. El detalle de cada uno, la sobreescritura por método y la jerarquía entre conjuntos están en Configurar límites en métodos (rate limit).
Paso Límites del asistente de API con las cuotas por período, el tiempo máximo de espera, la caché, los MB y el máximo de filas por página
Cuando se superan los límites establecidos la API responde con el código 429 y un mensaje que indica 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.