Muchas acciones, y que a veces incluso pueden parecer triviales, puede ser realizadas para ayudar al desarrollador que está implementando el consumo de las APIs a utilizarla correctamente, evitando así una sobrecarga de llamadas innecesarias e incorrectas además de la no comprensión de los flujos y acciones.

A continuación, vamos a listar 10 pasos que podrán ayudar en el proceso de garantizar el consumo de las APIs y así su utilización de forma optimizada y con éxito.

10 pasos para garantizar el éxito en el consumo de las APIs

1. Extracción de métricas

Extraer métricas de uso de las solicitudes ejecutadas hará que usted sepa exactamente la volumetría de uso y cuál es el porcentaje de Errores X Éxitos, además de identificar mayores ofensores de APPs/desarrollador, operación y tipo de error y consecuentemente, tomar medidas para mejorar la experiencia y el uso.

2. Alineamiento constante de errores

Realizar accionamientos al desarrollador, juntamente con evidencias y orientaciones de ajustes para tratativa, hará que sean alineados los escenarios de errores y sean suministradas informaciones y guías de corrección para tratativa en causa raíz. Suponiendo que su desarrollador realiza errores debido a alguna falla de proceso, es posible alinear cuanto antes junto a las evidencias y orientaciones para la corrección interna en el desarrollo.

3. Seguimiento de las llamadas ejecutadas de errores

Además de extraer e identificar los errores generados en el uso de las APIs, es importante también realizar un seguimiento constante. Así será una buena acción para la identificación de la causa/motivo de tales errores y también evaluar si el desarrollador ha realizado las correcciones necesarias. Será también en esta acción que ayudará en el ítem 2, donde será posible recoger las evidencias para alineamiento al desarrollador y seguir la usabilidad.

4. Portal de Desarrolladores con documentaciones e insumos sobre la API

El Portal de Desarrolladores es la entrada del desarrollador que desea consumir las APIs disponibles y deberá ser a través de este que las informaciones y guías de utilización deberá estar disponibles.

5. Documentación clara y elaborada en el Portal de Desarrolladores

Esto apoyará todo el proceso de onboarding y tornará más claro el entendimiento. Un Portal Dev de fácil comunicación es aquel que contiene lenguaje técnico y también de negocio, para una amplitud mayor de informaciones.

6. Inclusión de buenas prácticas en el Portal Dev sobre el uso de la API, reglas de negocio, posibles HTTP Status

Algunas de las informaciones que vemos que es necesario que sean incluidas en el Portal Dev, pues apoyará al desarrollador a entender las reglas de uso más objetivamente y poder así incluir reglas y entendimiento en el propio desarrollo.

7. Mensaje de retorno con información clara y explicativa del error

Así será más fácil la comprensión del desarrollador cuando ocurra un error. Exponer un mensaje amigable cuando ocurra un error, además de la estandarización de los HTTP Status, ayudará en la identificación de los errores y causas más fácilmente al desarrollador.

8. Desarrollo de reconocimiento de retornos del lado del desarrollador

Por ejemplo, que el desarrollador pase a identificar el error por medio del http status + mensaje de error expuesto y tome las medidas necesarias, evitando así la continuación del escenario repetitivamente.

9. Swagger con calidad

Un swagger bien detallado con la descripción de los campos, ejemplo de valores y todos los query params, ayudará a los desarrolladores y reducirá considerablemente el tiempo de “descubrimiento” de uso. 

10. Ambiente de pruebas

Para la simulación de los procesos que serán ejecutados/utilizados en producción. Así, el desarrollador podrá realizar las pruebas necesarias y diversas simulaciones, sin impacto al uso en el ambiente de producción.

Estos son algunos puntos para estar atento con relación a la experiencia que los desarrolladores están teniendo al consumir sus APIs, ya sean ellas abiertas o privadas. 

Aquí en Sensedia tenemos diversos recursos que pueden ayudar a tener más éxito con las estrategias de divulgación y onboarding en las APIs para garantizar que estén siendo bien aplicadas buenas prácticas.