¿Cómo puedo empezar a utilizar la API REST en Postman?
Respuesta:
La API REST de DocuWare es más accesible que nunca. Consulte la siguiente guía para configurar Postman para la API REST.
Primeros pasos
Descarga de Postman
Plataforma recomendada para probar y crear aplicaciones mediante API REST.
Colección Postman de API REST de DocuWare
Colección preconfigurada de llamadas API relevantes para DocuWare que se pueden importar a Postman y que se actualiza constantemente.
Importar la Postman Collection
- Descomprima la carpeta Postman Collection descargada. Dentro debe haber dos archivos .json.
- Un archivo es para la colección real de llamadas a la API, y el otro es el entorno que contiene algunas variables necesarias, como la URL de DocuWare Cloud, el nombre de usuario y la contraseña.
- Abra Postman y utilice la opción Importar situada en la parte superior del editor de espacios de trabajo.
- Arrastre y suelte los dos archivos, o vaya a la ubicación de descarga manualmente para importarlos.
- Acepte la solicitud de importar ambos archivos.
Definición de variables de entorno
- Abra la pestaña Entornos en el lado izquierdo y seleccione nuestro entorno DocuWare recién importado.
- Aquí verá un montón de variables diferentes, pero la mayoría son específicas de cada caso de uso y se pueden dejar por ahora. Algunas variables importantes para empezar son:
- ServerUrl (que termina en .cloud / .com, etc.). - estamos llenando el DocuWare / Plataforma en otra variable)
- Nombre de usuario
- Contraseña
- Guarde los cambios.
Autenticación
Hay varias formas de autenticarse utilizando la API REST, pero la más sencilla es utilizar nuestro nombre de usuario y contraseña. La colección Postman tiene todos estos numerados en consecuencia para ayudar a hacer de este un proceso sencillo:- Abra la carpeta Authentication/OAuth en Postman Collection.
- Comienza con la llamada 1. Get Responsible Identity Service y presiona Send. Suponiendo que la variable ServerUrl esté configurada correctamente, debería recibir una respuesta 200:
- A continuación, haga lo mismo con 2. Obtener configuración del servicio de identidad
- Por último, elija el método de autenticación que desee utilizar. En este ejemplo, utilizaremos 3.a Request Token w/ Username & Password, y deberíamos recibir nuestro Access Token en la respuesta.
- Ahora ya estás correctamente autenticado y puedes empezar a probar las demás llamadas dentro de Postman Collection.
La mayor parte de la documentación de nuestra API REST se puede encontrar directamente en Postman a través de la pestaña Documentación en el lado derecho:
KBA es aplicable tanto para organizaciones en la nube como locales.
Tenga en cuenta: Este artículo es una traducción del idioma inglés. La información contenida en este artículo se basa en la(s) versión(es) original(es) del producto(s) en inglés. Puede haber errores menores, como en la gramática utilizada en la versión traducida de nuestros artículos. Si bien no podemos garantizar la exactitud completa de la traducción, en la mayoría de los casos, encontrará que es lo suficientemente informativa. En caso de duda, vuelva a la versión en inglés de este artículo.
