Analytics
8
min de lectura
7 de julio de 2020

Cómo tener una integración saludable de la API

Luciana Bandeira
Developer Experience
Ayudo a los desarrolladores con onboarding y las mejores prácticas de la API para garantizar la mejor Developer Experience . En mi tiempo libre me dedico a los libros, a investigar (y probar) postres y me apasiona viajar.
Más sobre el autor

Anteriormente hemos publicado alguna información y directrices recomendadas por nuestro equipo de Developer Experienc aquí en Sensedia, y hoy vamos a seguir las mismas directrices y presentarles algunas acciones importantes para asegurar la calidad del uso y la salud de las API e integraciones.

- Asegúrate de que tienes un Portal para desarrolladores con información de la guía de desarrollo y directrices de uso.

Esto es muy importante para que su desarrollador sepa plenamente cómo hacer llamadas exitosas y tenga la mejor comprensión del uso.

Conocerán el proceso de autenticación necesario, cómo realizar correctamente las llamadas en las API, cómo identificar las devoluciones y otra información diversa pertinente para el desarrollo y la utilización.

- Siga a diario, sea por medio de logs, de métricas o de alertas automáticas las llamadas que están sucediendo en su integración

De esta forma, será posible identificar cuándo un desarrollador está ejecutando muchos errores, cuándo su backend se encuentra en un cuello de botella y sobre los demás escenarios importantes para tomar medidas de acciones y correcciones.

¡Esté atento! Requests con errores, de hecho, ocurren, pero lo importante es conseguir identificarlos y prevenirse para que no se genere un impacto (sea a quien está utilizando la API como a su backend y negocio).

– Utilice correctamente los retornos ofrecidos en la API

Estandarice sus devoluciones de llamadas. HTTP Status tiene sus normas de código conocidas en todo el mundo y usándolas correctamente será más fácil de entender e identificar los errores más rápidamente.

- Identificar los mayores infractores, tanto el APP/desarrollador que está causando el error como la razón de este escenario;

Con esto, podrá tener medidas y prevenir sus APIs y servicios de un aumento de error y sobrecarga indebida, además de conseguir identificar posibles fallas de comprensión del desarrollador o posibles mejoras de uso y claridad de su integración.

Muchas veces los mayores ofensores de los errores ocurridos son por falta de alguna comprensión de uso de API, o incluso alguna sobrecarga en el backend.

- Tener una visión técnica y de negocios

Muchas veces prestar atención solo en las cuestiones técnicas de las APIs no será suficiente para hacer a su API clara y fácil de usar. Usted puede compartir con su desarrollador cuestiones relacionadas al negocio, flujos y mejores formas y prácticas para usar las APIs. Seguramente eso lo ayudará a comprender todos los escenarios de uso.

- Tenga contacto cercano con sus aliados y desarrolladores externos;

¿Usted cuenta con un canal de atención y comunicación con sus aliados? ¿Está cercano a ellos como para tener una comunicación desde ambos lados de forma rápida y fácil? Este es un punto muy importante, ya que, teniendo este acercamiento, será más ágil para comunicarles fallas y mejoras de integración y también tener un apoyo en una visión externa de uso.

- Reciba feedbacks

Como comentamos antes, tener un acercamiento con los aliados/desarrolladores que utilizan la API es de extrema importancia, teniendo en cuenta que son ellos los que están en el día a día en el uso de estas llamadas, y tendrán una visión que muchas veces la persona que desarrolló/creó no tuvo (¡una visión externa es siempre positiva!)

Pide constantemente feedbacks a ellos, en esta acción podrán surgir muchas opiniones de mejoras e incluso indicaciones de los puntos fuertes de su API.

- Siempre busque mejoras

No es porque su API ya esté en producción y se esté utilizando que no puedan surgir mejoras con el tiempo.

La combinación de las acciones mencionadas puede mostrar si tienen problemas que pueden mejorarse en términos de flujo e incluso de utilidad.

Si ha identificado los puntos que pueden facilitar y aclarar el uso en los logs, seguimientos o contacto con su desarrollador, impleméntelos en sus API.

Esta mejora también es válida para el Portal del Desarrollador. La constante evolución de la documentación disponible hará que todo el proceso sea organizado y fácil. Entonces, ¿estás al tanto de estos elementos? ¿Pone en práctica estas acciones en su empresa y en sus API?

Comparte con nosotros si hay algo más que creas que es importante para garantizar el uso saludable y de calidad de los APIs!

¡Gracias por leer!