Defina la “API del bróker” antes de verificar los detalles
Una API de bróker es una interfaz técnica que permite que un sistema cliente envíe solicitudes a un bróker (o a la capa tecnológica del bróker) y reciba respuestas, como confirmaciones, actualizaciones de estado de órdenes e información relacionada con la cuenta. En este contexto, “verificar información” significa confirmar que una descripción del comportamiento de la API coincide con lo que la API realmente hace bajo las condiciones indicadas.
La verificación es más fácil cuando se separa la mecánica estable de las condiciones variables del proveedor. La mecánica estable son comportamientos que no deberían cambiar con la aleatoriedad del mercado—por ejemplo, cómo se validan los formatos de solicitud, cómo se realiza la autenticación y qué campos aparecen en las respuestas. Las condiciones variables son cosas que pueden diferir entre entornos o momentos, como los resultados de ejecución, la carga del servicio, los costos y el rendimiento de la red.
Utilice una jerarquía de fuentes que pueda probar
Utilice una jerarquía de evidencia, de la más autorizada a la más empírica:
- Documentación oficial de la API: Busque esquemas de solicitud/respuesta, códigos de error, descripciones del método de autenticación y restricciones documentadas.
- Documentos de referencia legales o técnicos del bróker: Estos pueden aclarar para qué está diseñada la API, cómo maneja los datos y qué limitaciones se aplican.
- Especificaciones de plataforma o protocolo (cuando corresponda): Si la API utiliza protocolos o formatos de mensaje estandarizados, la especificación subyacente ayuda a validar la semántica.
- Sus propias pruebas controladas: La verificación empírica es esencial para cualquier cosa que no esté completamente especificada, o cuando la documentación es ambigua.
Este enfoque evita tratar las descripciones de nivel de marketing como verdad técnica. También mantiene la verificación reproducible: las mismas entradas de prueba deberían conducir al mismo “tipo” de salidas, incluso si los resultados del mundo real difieren.
Pasos de verificación que son reproducibles
Siga una lista de verificación paso a paso que registre los supuestos y produzca evidencia que pueda comparar más adelante.
Paso 1: Enumere las afirmaciones y clasifíquelas
Cree una tabla con tres columnas: Afirmación, Qué la probaría y Clase de estabilidad (mecánica estable vs condición variable).
- Ejemplo de afirmación de mecánica estable: “Si a un cuerpo de solicitud le falta un campo obligatorio, la API devuelve una respuesta de error estructurada”.
- Ejemplo de afirmación de condición variable: “Esta orden se ejecutará de inmediato”. Esa no es una propiedad de API verificable de forma aislada.
Paso 2: Asigne cada afirmación a un artefacto documentado específico
Para cada afirmación de mecánica estable, identifique la sección de documentación relevante: campos de esquema, reglas de validación, estructura de respuesta o guía de manejo de errores. Si no existe ninguna sección, márquela como una brecha de documentación y planifique una prueba empírica.
Paso 3: Defina los supuestos para cualquier ejemplo o cálculo
Incluso para ejemplos simples, establezca los supuestos:
- Qué entorno está utilizando (sandbox vs producción).
- Qué identificadores utilizará (por ejemplo, una cuenta de prueba, códigos de instrumentos fijos).
- Si espera que la solicitud sea aceptada o rechazada (porque las entradas que elija son importantes).
Para marcas de tiempo y ordenamiento, registre la zona horaria e incluya un método de ordenamiento consistente. Para las cargas útiles, almacene el JSON exacto (o equivalente) que envió.
Paso 4: Ejecute pruebas controladas con entradas deterministas
Utilice pruebas que se centren en la estructura y la validación en lugar de predecir resultados de mercado.
- Envíe solicitudes bien formadas que deberían ser aceptadas.
- Envíe solicitudes intencionalmente mal formadas que deberían ser rechazadas.
- Varíe una entrada a la vez (por ejemplo, campo faltante, formato no válido, tipo incorrecto) mientras mantiene todo lo demás constante.
Capture la respuesta completa: código de estado (si corresponde), código de error, cuerpo del mensaje y cualquier identificador de correlación.
Paso 5: Realice una “verificación de integridad” de su evidencia
Antes de concluir, verifique que realmente observó el comportamiento que probó:
- ¿Recopiló la respuesta de cada solicitud que envió?
- ¿Registró la carga útil exacta y el momento?
- ¿La capa de red del lado del cliente (tiempos de espera/reintentos) interfirió con lo que cree que sucedió?
Si falta evidencia o es inconsistente, repita la prueba con una instrumentación más clara.
Paso 6: Interprete los resultados dentro de las limitaciones
No trate una sola ejecución de prueba como una verdad universal. Una API podría comportarse correctamente para una forma de solicitud, pero fallar bajo carga o cuando se excede un límite de velocidad. Compare el comportamiento observado en múltiples ejecuciones, especialmente para casos límite.
Limitaciones materiales y modos de fallo a verificar
Al verificar la información de la API del bróker, espere incertidumbre y pruebe los modos de fallo.
Limitaciones materiales comunes:
- Límites de velocidad y limitación: Las solicitudes pueden ser rechazadas o retrasadas cuando se exceden los límites documentados. - Fallos de validación de solicitudes: Los campos faltantes o no válidos pueden causar errores estructurados; verifique cómo se representan esos errores.