Según su propia experiencia, ¿cuáles son los principales obstáculos que causan lentitud al integrar una API con su producto?

En OneSaas integramos decenas de API desde REST a WebServices, JSON, OAuth hasta simples como FTP.

Aquí estaría mi lista de obstáculos:

  1. Falta de documentación, con mucho, la razón principal.
  2. Documentación fuera de los datos (generalmente faltan campos en la documentación que mágicamente “aparecen” durante las pruebas)
  3. Inconsistencias en la API: diferentes formatos de tiempo de datos en diferentes campos, diferentes formatos xml para diferentes solicitudes o respuestas
  4. Nombres inconsistentes (created_at, updatedat)
  5. 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
  6. 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.
  7. 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
  8. 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.
  9. Falta LastUpdated o LastModified en entidades para que nunca se sepa si los datos se modificaron o no.
  10. 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”.

Durante la fase de desarrollo, el obstáculo principal (además de los errores) es la documentación y el soporte deficientes del propietario de la API. Estoy experimentando este mismo problema ahora con BoldChat.

Sin código de muestra