Al integrar las APIs en un sistema hay que realizar ciertas preguntas para asegurar que la integración tenga el menor número de incidencias
:
I. Aspectos técnicos
1. ¿Con qué tipo de API estamos tratando? ¿REST, SOAP, GraphQL?
2. ¿Qué método de autenticación es requerida? ¿claves API, OAuth, JWT?
3. ¿Hay niveles de acceso diferentes para cada tipo de usuarios?
4. ¿Qué formato de datos soporta la API? ¿JSON, XML?
5. ¿Qué operaciones específicas pueden realizar cada endpoint?
6. ¿Hay algún límites o cuotas de consultas?
7. ¿Cómo comunica los errores la API? ¿Sigue algún estándar para los mensajes de error?
II. Desempeño y escalabilidad
1. ¿Cuál es el tiempo de respuesta esperado?
2. ¿La API puede soportar la carga esperada? Como usuario de una API, la tarea es calcular lo esperado como consumidor de la API.
3. ¿Hay mecanismos de escalado?
4. ¿Se puede aplicar el uso de caché de datos? ¿Cuál es la estrategia apropiada?
III. Consideraciones de seguridad
1. ¿Qué estándares de encriptación son utilizados? En algunas APIs la información sensible se envía de forma encriptada.
2. ¿La API cumple con estándares de la industria como GDPR o HIPAA?
3. ¿Qué se hace con la información que envío?
IV. Soporte
1. ¿Dónde encuentro la documentación de la API? ¿Hay ejemplos de código y casos de uso?
2. ¿Qué nivel de soporte ofrece el proveedor o dueño de la API? ¿Existen SLA?
3. ¿Cómo se manejan las versiones en la API? ¿Cuál es la política para APIs antiguas u obsoletas?
1. ¿Existe un entorno de prueba?
2. ¿Cuáles son los mecanismos de logging que existen? Si algo falla ¿cómo puedes ver los logs en su lado?
0 Comentarios