La interfaz de usuario y la documentación de Print Portal hacen referencia a las carpetas raíz para describir las carpetas que ha configurado para que estén disponibles en Print Portal. La API REST se refiere a estas carpetas como "librerías". Verá esta diferencia cuando solicite una lista de (o enumere) carpetas raíz. Cuando se enumera el contenido de una carpeta raíz (librería), se enumeran todas las subcarpetas y los elementos que las componen, ya sean subcarpetas o documentos.
Una API REST es un estilo de arquitectura de software para adquirir y manipular representaciones textuales del contenido de los recursos web. La API REST de Print Portal representa los datos en formato JSON, por lo que los datos que se envían y devuelven están en formato JSON.
Los ejemplos de este tutorial comienzan con las solicitudes de URL y la respuesta, utilizando el navegador. También hay ejemplos de JavaScript para construir solicitudes mediante programación.
Para los pasos de este tutorial, el navegador está en el mismo cliente en el que está instalado Print Portal, por lo que se utiliza "localhost" en la cadena URI.
Print Portal contiene un sistema de especificación de la API REST llamado Swagger. Swagger puede considerarse un sistema de ayuda de la API REST que proporciona explicaciones para cada función y un entorno de ejecución para probar las solicitudes.
|
|
To view the Swagger user interface, add "swagger" after "BarTender" in the BarTender URI, as follows: http://localhost/BarTender/swagger/ |
La presentación de Swagger está dividida en dos partes. La sección superior contiene explicaciones de las funciones de la API y la funcionalidad con la que probar las solicitudes de la API. La sección inferior, titulada Modelos, ofrece una explicación de cada función y sus requisitos. Por ejemplo, si necesita saber qué es printRequestID, entra en la sección Models y haz clic en PrintRequest para que aparezca una lista de argumentos y sus definiciones, una de las cuales es printRequestID.