Saltar al contenido principal

API Interna

La API Interna permite a los módulos locales interactuar con el Gateway para crear, gestionar y descargar paquetes.

Base URL: https://tu-gateway.local/gateway-interna/v1

Endpoints Principales

Información del Servicio

  • GET /info: Información básica de la API.
    • Respuesta: {"nombre": "ARAI-Gateway Interna", "version": "v1.0.0", ...}

Gestión de Paquetes

  • POST /paquetes: Crear un nuevo paquete.

    • Body: {"institucion_destino": "uuid", "modulo_destino": "uuid", "modulo_origen": "uuid", "indicacion": {...}}
    • Respuesta: {"identificador": "uuid-del-paquete"}
  • POST /paquetes/{id}/cargar-texto: Cargar contenido de texto.

    • Body: "contenido como string"
    • Respuesta: [] (éxito)
  • PUT /paquetes/{id}/finalizar: Marcar paquete como listo para envío.

    • Respuesta: 204 No Content
  • PUT /paquetes/{id}/anular: Anular un paquete (antes de envío).

    • Body: {"motivo": "razón"}
    • Respuesta: 204 No Content
  • GET /paquetes/{id}/movimientos: Consultar movimientos del paquete.

    • Respuesta: Array de movimientos con estado, fecha, etc.

Novedades

  • GET /novedades?modulo={uuid}: Consultar paquetes disponibles para un módulo.

    • Respuesta: Array de novedades [{"identificador": "uuid", "fecha": "..."}]
  • PUT /novedades/{id}/recibida: Marcar novedad como recibida.

    • Respuesta: 204 No Content

Descargas

  • PUT /descargas/{id}/iniciar: Iniciar descarga de paquete.

    • Respuesta: Metadata del paquete (hash, partes, etc.)
  • GET /descargas/{id}/contenido?parte={id_parte}: Descargar contenido.

    • Respuesta: Contenido del paquete
  • PUT /descargas/{id}/finalizar: Confirmar descarga exitosa.

    • Respuesta: 204 No Content
  • PUT /descargas/{id}/fallida: Reportar error en descarga.

    • Respuesta: 204 No Content

Códigos de Estado

  • 200: Éxito (con body).
  • 201: Creado.
  • 204: Éxito (sin body).
  • 400: Error en parámetros.
  • 401: No autorizado.
  • 404: Recurso no encontrado.
  • 500: Error interno.