Anteriormente publicamos algunas informaciones y orientaciones recomendadas por nuestro equipo de Developer Experience de Sensedia, y hoy, continuando con esas mismas orientaciones les pasaremos algunas acciones importantes para asegurar la calidad de uso y salud de las APIs e integraciones.

– Cuente con un Portal de Desarrolladores con las informaciones de guía de desarrollo y orientaciones de uso.

Este caso es muy importante para que su desarrollador sepa totalmente cómo realizar llamadas exitosas y tenga la mejor comprensión de uso.

Él sabrá el proceso de autenticación necesario, cómo realizar las llamadas correctamente en las APIs, cómo identificar los retornos y muchas otras informaciones pertinentes para el desarrollo y uso.

– 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 retornos de llamadas. El uso de los HTTP Status tiene sus estándares de códigos conocidos mundialmente y utilizarlo correctamente será más fácil de comprender e identificar los errores más rápidamente.

– Identifique los mayores ofensores, tanto la APP/desarrollador que está ocasionando el error, así como también el motivo 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.

– Tenga una visión técnica y de negocio

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.

– Esté siempre buscando mejoras

No porque su API ya está en producción y en uso, significa que no puedan surgir mejoras con el paso del tiempo. La unión de las acciones citadas anteriormente podrá mostrar si hay cuestiones que pueden ser mejoradas en términos de flujo, e incluso de uso.

Si ha identificado en los logs, en los seguimientos, en los contactos con su desarrollador puntos que pueden facilitar y hacer un uso más claro, hágalos dentro de sus APIs.

Esta mejora también es válida para el Portal de Desarrolladores, evolucionar de manera constante las documentaciones disponibles hará a todo el proceso bien coordinado y fácil.

Entonces, ¿está atento a estos ítems y pone en práctica dichas acciones dentro de su empresa y de sus APIs?

¡Cuéntanos si hay algo más que creas importante de prestarle atención para que aseguremos el uso de las APIs de forma saludable y con calidad!