15 preguntas que debe hacer sobre su API antes de seleccionar una plataforma

Preguntas sobre la selección de API

Un buen amigo y mentor me escribió y me hizo una pregunta y me gustaría usar mis respuestas para esta publicación. Sus preguntas estaban un poco más centradas en una industria (correo electrónico), así que generalicé mis respuestas a todas las API. Preguntó qué preguntas debería hacer una empresa a un proveedor sobre su API antes de hacer una selección.

¿Por qué necesita API?

An interfaz de programación de aplicaciones (API) es la interfaz que proporciona un sistema informático, biblioteca o aplicación para permitir que otros programas informáticos realicen solicitudes de servicios y / o para permitir el intercambio de datos entre ellos.

Wikipedia

Al igual que escribe una URL y obtiene una respuesta en una página web, una API es un método en el que sus sistemas pueden solicitar y obtener una respuesta para sincronizar datos entre ellos. A medida que las empresas buscan transformarse digitalmente, la automatización de tareas a través de API es una excelente manera de mejorar la eficiencia dentro de la organización y reducir el error humano.

Las API son fundamentales para la automatización, especialmente en aplicaciones de marketing. Uno de los desafíos a la hora de comprar un gran proveedor con un API es que los recursos y gastos de desarrollo suelen ser una idea posterior. El equipo de marketing o CMO puede impulsar la compra de una aplicación y, a veces, el equipo de desarrollo no recibe muchos comentarios.

Investigar las capacidades de integración de una plataforma a través de una API requiere más que una simple pregunta, ¿Existe una API?

Si inicia sesión con una aplicación con una API documentada o con soporte deficiente, volverá loco a su equipo de desarrollo y es probable que sus integraciones se queden cortas o fallan por completo. Encuentre el proveedor adecuado, su integración funcionará y su personal de desarrollo estará encantado de ayudarlo.

Preguntas de investigación sobre sus capacidades API:

  1. Brecha de características - Identificar qué funciones de su interfaz de usuario están disponibles a través de la interfaz de programación de aplicaciones. ¿Qué características tiene la API que la UI no tiene y viceversa?
  2. Escalable - Pregunte cuántas llamadas se hacen a sus API diario. ¿Tienen un grupo de servidores dedicado? La cantidad es increíblemente importante ya que desea identificar si la API es una ocurrencia tardía o en realidad parte de la estrategia de la empresa.
  3. Documentación - Solicite la documentación de la API. Debe ser sólido y detallar todas las funciones y variables disponibles en la API.
  4. Comunidad - Pregunte si tienen o no una comunidad de desarrolladores en línea disponible para compartir código e ideas con otros desarrolladores. Las comunidades de desarrolladores son clave para lanzar sus esfuerzos de desarrollo e integración de manera rápida y eficiente. En lugar de aprovechar al "tipo de API" de la empresa, también está aprovechando a todos sus clientes que ya han tenido pruebas y errores al integrar su solución.
  5. DESCANSO vs JABÓN - Pregunte qué tipo de API tienen ... Normalmente hay API REST y API de servicio web (SOAP). Pueden estar desarrollando ambos. La integración con cualquiera de ellos tiene ventajas y desventajas ... debe estar familiarizado con las capacidades de sus recursos de integración (TI).
  6. Idiomas - Pregunte con qué plataformas y aplicaciones se han integrado con éxito y solicite contactos para que pueda averiguar de esos clientes qué tan difícil fue la integración y qué tan bien funciona la API.
  7. Limitaciones - Pregunte qué limitaciones tiene el proveedor en la cantidad de llamadas por hora, por día, por semana, etc. Si no está con un proveedor escalable, su crecimiento estará limitado por el cliente.
  8. Muestras - ¿Ofrecen una biblioteca de ejemplos de código para comenzar fácilmente? Muchas empresas publican SDK (kits de desarrollo de software) para diferentes lenguajes y marcos que acelerarán su cronograma de integración.
  9. Salvadera - ¿Ofrecen un entorno de zona de pruebas o de punto final que no sea de producción para que pruebes tu código?
  10. Recursos - Pregunte si tienen recursos de integración dedicados dentro de su empresa. ¿Tienen un grupo de consultoría interno disponible para la integración? Si es así, ¡añade algunas horas al contrato!
  11. Seguridad - ¿Cómo se autentican usando la API? ¿Son credenciales de usuario, claves u otras metodologías? ¿Pueden restringir las solicitudes por dirección IP?
  12. Uptime - Pregunte cuál es su API el tiempo de actividad y la tasa de error, y cuándo son sus horas de mantenimiento. Además, las estrategias para solucionarlos son importantes. ¿Tienen procesos internos que volverán a intentar API llamadas en caso de que el registro no esté disponible debido a otro proceso? ¿Es esto algo que han diseñado en su solución?
  13. SLA - Tienen un Acuerdo de Nivel de Servicio ¿Dónde los tiempos de actividad deberían ser superiores al 99.9%?
  14. Hoja de ruta - ¿Qué características futuras están incorporando en su API y cuáles son los cronogramas de entrega esperados?
  15. Sistemas integrados - ¿Qué integraciones productizadas han desarrollado o que han desarrollado terceros? A veces, las empresas pueden renunciar al desarrollo interno de funciones cuando ya existe otra integración productiva y se está apoyando.

La clave de estas preguntas es que la integración te 'casa' con la plataforma. No quieres casarte con alguien sin conocer todo lo que puedas sobre él, ¿verdad? Esto es lo que sucede cuando la gente compra una plataforma sin conocer sus capacidades de integración.

Más allá de una API, también debe intentar averiguar qué otros recursos de integración pueden tener: códigos de barras, mapas, servicios de limpieza de datos, RSS, formularios web, widgets, integraciones formales de socios, motores de secuencias de comandos, descargas SFTP, etc.