Cómo usar el cartero

Postman es una plataforma API para construir y utilizar APIs. Vincular tu proyecto Document360 con Postman es fácil y se puede completar en pocos minutos. Puedes usar el Postman local o en la web.

NOTA

Para más información sobre la solicitud de cartero, lee los siguientes artículos.

• ¿Cómo descargar la aplicación de Postman?

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

• ¿Cómo usar Postman?

• Preguntas frecuentes en Postman

Vinculando tu proyecto Document360 en Postman

1. Los siguientes pasos se basan en la solicitud de cartero local.

2. Abre la solicitud de Cartero.

3. En la sección Mi Espacio de Trabajo , haz clic en el botón Importar .

   Aparece un panel emergente de Importación .

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

5. Selecciona la opción deseada

   • Colección del cartero (por defecto)

   • OpenAPI 3.0 con una colección Postman

6. Haz clic en el botón Importar .

   Una vez terminada la importación, la acción creará una solicitud de ejemplo para cada endpoint, permitiéndote hacer la solicitud rápidamente.
   

   

Autenticación en Postman - Generación de un token API

1. En la vista de árbol, expande la API de Cliente de Document360.

2. En la pestaña de Autorización, establece el tipo de autenticación como clave API desde el desplegable.

3. Introduce la variable deseada en el campo Clave .

4. Introduce el token API en el campo Valor. Para generar un token de API, lee el artículo sobre Generación de token.

   NOTA

   Generación de un token API

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

   2. En el panel de navegación izquierdo, navega al Portal de la base de conocimientos > Tokens de API.

   3. Crea el token de API deseado y cópialo de nuevo.

   (o) Copia el token de un token existente.

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

2. Desde el panel de navegación izquierdo, haz clic en Crear entornos.

3. En la columna Variables , escribe el nombre de una variable, por ejemplo, 'base_URL', y pon el Tipo como predeterminado.

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

5. Haz clic en el botón de guardar .

   La autenticación del proyecto está completada. Ahora puedes acceder fácilmente a todos los puntos finales disponibles y realizar diversas acciones.

   

Casos de uso

Con la ayuda de Postman, puedes realizar diversas acciones en Document360.

Aquí tienes algunos casos de uso básicos para tu referencia

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

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

• ¿Cómo actualizar los detalles de SEO?

Preguntas frecuentes