Contrato de interfaz
Un contrato de interfaz describe el intercambio de datos acordado. La estructura, las respuestas y el significado deben encajar para ambas partes.
Un contrato de interfaz es la descripción acordada de cómo deben intercambiar datos los sistemas. Incluye entradas esperadas, respuestas, errores y significado de esos mensajes. Una descripción legible por máquina puede expresar parte de ello; los acuerdos de negocio también deben ser comprensibles.
Registrar el significado de una respuesta
En un portal de clientes ficticio, una transmisión correcta solo confirma inicialmente la recepción por un componente intermediario. Saber si el ERP creó el pedido exige una respuesta aparte. Si el emisor interpreta la primera respuesta como finalización completa, su uso no corresponde al acuerdo.
Contrastar descripción e implementación
OpenAPI define una descripción estandarizada para API HTTP. Estas descripciones ayudan a comprender operaciones y respuestas disponibles. No demuestran por sí solas que la aplicación en ejecución cumpla el flujo acordado. Contraste ejemplos adecuados y casos de error con la implementación. En los cambios, debe quedar claro qué sistemas participantes se basan en qué acuerdo.
Fuentes
Términos relacionados
- JSON SchemaJSON Schema describe la estructura y las restricciones de datos JSON. Un validador revisa las reglas; cumplirlas aún no demuestra corrección de negocio.
- Inbox transaccionalUn inbox transaccional usa registros duraderos de mensajes para proteger el procesamiento local frente a entregas duplicadas.
- Confirmación de mensajesLa confirmación informa al broker de que una entrega se ha recibido o procesado según la regla acordada.
- Variación aleatoria entre reintentosEl jitter de reintentos varía aleatoriamente las esperas para repartir los reintentos y reducir las solicitudes simultáneas de varios clientes.
- Espacio de cliente de pruebasUn espacio lógico delimitado de una aplicación multitenant, configurado para comprobaciones.
- Reenvío de webhookEl reenvío de webhook vuelve a transmitir una notificación. La recuperación deliberada y los ataques de repetición requieren comprobaciones diferentes.
Artículos sobre el tema
APIs e integración con ASES
ERP, CRM y tienda bien conectados