API de REST HTTP
RaptorXML+XBRL Server acepta trabajos enviados a través de HTTP (o HTTPS). La descripción del trabajo así como los resultados se intercambian en formato JSON. El diagrama que aparece a continuación muestra el flujo de trabajo.
Cuestiones de seguridad relacionadas con la API de REST HTTPPor defecto, la API de REST HTTP permite escribir los documentos de salida en cualquier ubicación especificada por el cliente (que sea accesible con el protocolo HTTP). Por tanto, es importante tener en cuenta este aspecto de seguridad a la hora de configurar RaptorXML+XBRL Server.
Si le preocupa que esto pueda comprometer la seguridad de su sistema o que la interfaz se utilice de forma incorrecta, puede configurar el servidor para que escriba los documentos de salida en un directorio de salida específico del servidor mismo. Esto se consigue configurando el valor false para la opción server.unrestricted-filesystem-access del archivo de configuración del servidor. Si se limita así el acceso, el cliente puede descargar los documentos de salida del directorio de salida específico mediante solicitudes GET. Otra opción es que el administrador copie los documentos de salida del servidor en la ubicación de destino o los suba a dicha ubicación. |
Temas de esta sección
Antes de enviar una solicitud cliente, RaptorXML+XBRL Server debe iniciarse y configurarse correctamente. La forma de hacerlo se describe en la sección Preparar el servidor. En la sección Solicitudes cliente se describe cómo enviar solicitudes de clientes. El tema Archivo de descripción de OpenAPI describe el archivo de definición de OpenAPI que se incluye con RaptorXML+XBRL Server y que permite interactuar con la API HTTP. Por último, la sección Ejemplo en C# para la API de REST describe el archivo de ejemplo de la API de REST que se instala con el paquete RaptorXML+XBRL Server.