En OneSaas integramos decenas de API desde REST a WebServices, JSON, OAuth hasta simples como FTP.
Aquí estaría mi lista de obstáculos:
- Falta de documentación, con mucho, la razón principal.
- Documentación fuera de los datos (generalmente faltan campos en la documentación que mágicamente “aparecen” durante las pruebas)
- Inconsistencias en la API: diferentes formatos de tiempo de datos en diferentes campos, diferentes formatos xml para diferentes solicitudes o respuestas
- Nombres inconsistentes (created_at, updatedat)
- Tipos de datos ejemplificados incorrectos (por ejemplo, la documentación dice: 1234 por lo que supone que es un int). Usted prueba y vuelve a aparecer como ABCD , por lo que debe cambiar su tipo
- Zonas horarias no especificadas para horas de datos, por lo que no puede alinear adecuadamente las fechas y horas con UTC o con alguna otra zona horaria de referencia.
- Faltan “búsquedas” (p. Ej., Obtener todos los cambios desde un punto específico en el tiempo), por lo que debe recuperar todos los datos para detectar cambios
- Entidades que requieren dos llamadas para obtener el conjunto completo. Por ejemplo, GetInvoice y GetInvoiceDetails, pero GetInvoice no contiene suficientes detalles para indicarle que hay cambios en los detalles, por lo que también debe solicitarlos.
- Falta LastUpdated o LastModified en entidades para que nunca se sepa si los datos se modificaron o no.
- Y el peor delincuente: mensajes de error no documentados para que las pruebas se conviertan en un juego de “busquemos otro escenario en el que podamos obtener algún error aleatorio”.
- ¿Están muertos los teléfonos inteligentes?
- ¿Qué hace a China tecnológicamente tan superior?
- ¿Qué te emociona sobre el futuro de la realidad virtual?
- ¿Cómo sería nuestro nivel tecnológico y social si todos mantuvieran su inteligencia y habilidades pero tuvieran mentes e impulsos criminales?
- Estados Unidos es la nación tecnológicamente más avanzada del planeta. ¿Qué debemos hacer con todos nuestros Bubba's y Bubettes?