¿Cómo usar Postman?

Postman es una plataforma API para crear y usar API. Vincular su proyecto de Document360 con Postman es fácil y se puede completar en unos minutos. Puede usar Postman local o basado en web.

NOTA

Para obtener más información sobre la aplicación de Postman, lea los siguientes artículos.

• How to download Postman application?

• ¿Cómo instalar y actualizar la aplicación Postman?

• ¿Cómo usar Postman?

• FAQs in Postman

Vincular el proyecto de Document360 en Postman

1. Los pasos siguientes se basan en la aplicación Postman local.

2. Abra la aplicación Postman.

3. En la sección Mi espacio de trabajo , haga clic en el botón Importar .

   Aparece un panel emergente Importar .

4. Ingrese la siguiente URL en el campo.
   https://apihub.document360.io/swagger/v2/swagger.json
   Aparecerá la ventana emergente Elegir cómo importar su API con dos opciones.

5. Seleccione la opción deseada

   • Colección Postman (predeterminado)

   • OpenAPI 3.0 con una colección Postman

6. Haga clic en el botón Importar .

   Una vez realizada la importación, la acción creará una solicitud de muestra para cada punto final, lo que le permitirá realizar la solicitud rápidamente.
   

   

Autenticación en Postman: generación de un token de API

1. En la vista de árbol, expanda API de cliente de Document360.

2. En la pestaña Autorización, establezca el Tipo de autenticación en Clave de API en el menú desplegable.

3. Introduzca la variable deseada en el campo Clave .

4. Introduzca el token de API en el campo Valor. Para generar un token de API, lea el artículo sobre Generating token.

   NOTA

   Generación de un token de API

   1. Vaya a Configuración () en la barra de navegación izquierda del portal de Knowledge Base.

   2. En el panel de navegación izquierdo, vaya a Portal de la base de conocimientos > tokens de API.

   3. Cree el token de API deseado y cópielo.

   (o) Copie el token de un token existente.

1. En la barra de navegación izquierda, vaya a Entornos.

2. En el panel de navegación izquierdo, haga clic en Crear entornos.

3. En la columna Variables , escriba un nombre de variable, por ejemplo, "base_URL" y establezca el Tipo en predeterminado.

4. Introduzca https://apihub.document360.io los campos VALOR INICIAL y VALOR ACTUAL para la URL base.

5. Haga clic en el botón Guardar .

   Se ha completado la autenticación del proyecto. Ahora puede acceder fácilmente a todos los puntos finales disponibles y realizar varias acciones.

   

Casos de uso

Con la ayuda de Postman, puede realizar varias acciones en Document360.

Aquí hay algunos casos de uso básicos para su referencia

• ¿Cómo crear y publicar un artículo?

• ¿Cómo actualizar un artículo publicado?

• ¿Cómo actualizar los detalles de SEO?

Preguntas más frecuentes