INT-{{title}}
Integration Type
| Atributo | Valor |
|---|---|
| Tipo | Webhook / REST / SOAP / SSO / mTLS / SFTP / Event-Driven |
| Dirección | Inbound / Outbound / Bidirectional |
| Patrón | Sync / Async / Batch |
| Proveedor/Sistema | |
| Versión del API | |
| Base URL prod | |
| Base URL staging |
Authentication Model
| Atributo | Valor |
|---|---|
| Método | API Key / OAuth2 / mTLS / SAML / Basic Auth |
| Credenciales almacenadas en | Vault / K8s Secret / Env vars |
| Rotación de credenciales | Manual / Automática / Cada X días |
| IP Whitelisting | Sí/No |
| IPs permitidas |
Flujo de autenticación
Data Exchanged
Datos enviados (Outbound)
| Campo | Tipo | Sensible | Descripción |
|---|---|---|---|
| Sí/No |
Datos recibidos (Inbound)
| Campo | Tipo | Sensible | Descripción |
|---|---|---|---|
| Sí/No |
Transformaciones
| Dato origen | Dato destino | Transformación |
|---|---|---|
Error Handling
| Código/Error | Significado | Acción | Retry |
|---|---|---|---|
| 400 | No | ||
| 401 | Renovar token | Sí (1x) | |
| 429 | Rate limit | Backoff exponencial | Sí |
| 500 | Alerta + retry | Sí (3x) | |
| Timeout | Circuit breaker | Sí |
Dead Letter Queue
- Habilitada: Sí/No
- Queue:
[[INFRA-RabbitMQ]] - Retention:
- Proceso de reintento manual:
SLA Expectations
| Métrica | Valor esperado | Medición |
|---|---|---|
| Disponibilidad | ||
| Latencia p95 | ||
| Throughput máximo | ||
| Ventana de mantenimiento |
Contacto del proveedor
- Soporte:
- SLA contractual:
- Escalamiento:
Versioning
| Versión | Fecha | Cambio | Breaking |
|---|---|---|---|
| v1.0 | Implementación inicial | — | |
Estrategia de versionado
- Versionado por: URL path / Header / Query param
- Soporte simultáneo de versiones: Sí/No
- Deprecation policy:
Security Considerations
- Comunicación encriptada (TLS 1.2+)
- Certificados válidos y monitoreados
- Credenciales en vault/secrets (no en código)
- Input validation en datos recibidos
- Output sanitization en datos enviados
- Rate limiting configurado
- Audit log de todas las transacciones
- No se exponen datos internos en errores
- Datos PII encriptados en tránsito y reposo
Monitoring
Health Check
- Método de verificación: Ping / Test transaction / Status endpoint
- Frecuencia:
- Alerta si falla:
Métricas
| Métrica | Alerta | Dashboard |
|---|---|---|
| Tasa de error | > X% en Y min | |
| Latencia | > X ms p95 | |
| Volumen | < X req/min | |
| Certificado expira | < 30 días |
Logs
| Evento | Nivel | Datos |
|---|---|---|
| Request enviado | DEBUG | endpoint, method |
| Response recibido | DEBUG | status, latency |
| Error | ERROR | code, message, trace_id |
| Auth failure | WARN | reason, IP |