Bienvenido al API de estadísticas versión 2.0
Gracias a la retroalimentación de los usuarios, lanzamos la versión 2.0 de nuestro api de estadísticas con algunas mejoras importantes y nuevas experiencias.
Contenido
· 1. ¿Cuáles son las mejoras de la versión 2 del API?
· 2. Mejoras:
∘ 2.1 MEJORA EN EL RENDIMIENTO:
∘ 2.2 FACILIDAD DE USO:
∘ 2.3 EFICIENCIA EN LA MEMORIA:
· 3. ¿Qué pasará con la versión beta del API?
∘ 3.1 ¿Necesito crear una cuenta nueva?
· 4. Recomendaciones de uso y buenas prácticas
1. ¿Cuáles son las mejoras de la versión 2 del API?
Las mejoras implementadas están relacionadas con la forma de recepción de la información solicitada. Anteriormente, el requerimiento de datos se hacía en una sola petición pudiendo generar una carga muy pesada en su PC/red y, a su vez, podría causar interrupciones o hasta fallos inesperados (si la data que retorna la petición es excesivamente grande).
En esta versión, hemos implementado el concepto de paginación, un estándar en consumos de APIs que manejan grandes cantidades de registros. Ahora podemos indicarle al endpoint cuántos registros queremos recibir por petición permitiendo que se devuelva solamente la cantidad de páginas solicitadas, haciendo más eficiente el consumo de recursos computacionales.
Un API paginado devuelve la información en pequeñas partes o páginas en lugar de entregar toda la información en una sola respuesta. Ahora el usuario deberá especificar el número de páginas y la cantidad de registros que desea recuperar. Esto hará que la respuesta le devuelva la página solicitada con información adicional sobre el número total de elementos y páginas disponibles.
2. Mejoras:
2.1 MEJORA EN EL RENDIMIENTO:
Al paginar los resultados de una API, se pueden limitar la cantidad de datos que se transmiten en cada solicitud. Esto ayuda a reducir el tiempo
de respuesta, además de la carga para su PC y red. El resultado es un API más rápido.
2.2 FACILIDAD DE USO:
Esto se debe a que el usuario puede especificar el número de resultados que desea recibir en cada página y navegar por los resultados de manera más sencilla.
2.3 EFICIENCIA EN LA MEMORIA:
Un API paginado permite cargar los datos en la memoria de manera más eficiente. Específicamente, de gran importancia para los endpoint que manejan números elevados de registros como son los de captaciones y cartera. *Se realizaron varias peticiones a diferentes endpoints y se sumaron los tiempos finales. ¡Los endpoint de captaciones y cartera están
unificados!.
Ahora podrás acceder a la información de la cartera y captaciones de manera unificada. Con la nueva arquitectura del API, ahora es posible tenerlo todo junto, y se han creado dos nuevos endpoints: “Detalle de captaciones” y “Cartera de crédito total”.
3. ¿Qué pasará con la versión beta del API?
La versión actual seguirá funcionando durante los próximos seis meses, para que puedan adaptarse a los nuevos cambios. Les recomendamos que realicen la transición lo más pronto posible, para que puedan disfrutar de una experiencia mejorada.
3.1 ¿Necesito crear una cuenta nueva?
No es necesario crear otra cuenta. Solo debes iniciar sesión con tu cuenta en el portal de desarrolladores y suscribirte al API V2. Si ya tienes un API KEY de la versión anterior lo puedes utilizar con la v2 sin necesidad de crear uno nuevo.
4. Recomendaciones de uso y buenas prácticas
Utilizar un almacenamiento intermedio para cargar la serie completa de los datos e ir actualizando solo los nuevos períodos de información.
Conectar sistemas de visualización y herramientas de ciencia de datos a partir de ese almacenamiento intermedio.
Evitar conectar herramientas de explotación de datos directamente a endpoints con grandes cantidades de información, como captaciones y cartera.
El almacenamiento intermedio puede ser una base de datos relacional o no relacional, también puede ser archivos de almacenamiento como CSV, Apache Parquet, Apache Avro, entre otros
NOTAS: Para contextualizar, algunas pruebas que realizamos requieren aproximadamente 20GB de memoria RAM para cargar la serie completa de los endpoints de “Detalles Captaciones” y “Cartera Crédito Total”. Además, es importante considerar factores como la velocidad de red y la capacidad del hardware de su computadora. En resumen, si cuenta con una computadora potente y una red de alta velocidad, descargar la serie completa de estos dos endpoints podría tomar de 4 a 6 horas, con una cantidad de registros que, dependiendo el filtro, puede ir desde los 10 millones a los 15 millones de registros multiplicado por 26 columnas (Es mucha información)
