Documentación de APIs

Conceptos públicos para integrar con seguridad y trazabilidad.

Esta documentación es ilustrativa. Los endpoints reales, credenciales y contratos se entregan únicamente dentro del proyecto correspondiente.

Autenticación

Las APIs pueden utilizar API keys, tokens u otros mecanismos según el proyecto.

Authorization: Bearer <token> Content-Type: application/json

Solicitudes

Los datos deben cumplir formato, tipos y reglas funcionales.

{ "transaction_id": "EXT-000152", "customer_id": 245, "amount": 150000 }

Respuestas

Las respuestas deben indicar éxito, identificadores y estado.

{ "success": true, "result": { "id": 9871, "status": "PROCESSED" } }

Errores

Los códigos y mensajes deben permitir diagnóstico sin exponer información sensible.

  • 400 — Datos inválidos
  • 401 — No autenticado
  • 403 — Sin permiso
  • 404 — Recurso inexistente
  • 409 — Conflicto o duplicado
  • 500 — Error interno

Idempotencia

Las operaciones críticas pueden requerir una clave única para evitar duplicados.

Idempotency-Key: EXT-2026-000152