Contenido

Introducción

Prerequisites

Requirements

Componentes Utilizados

Documentación de API de AccessOnboard

Probar API desde la herramienta de documentación

Información Relacionada

Introducción

Este documento describe cómo validar y configurar las llamadas API REST a vManage mediante la documentación integrada.

Prerequisites

Requirements

No hay requisitos específicos para este documento.

Componentes Utilizados

Este documento no se limita a versiones de software específicas o tipos de implementación de vManage.

La información que contiene este documento se creó a partir de los dispositivos en un ambiente de laboratorio específico. Todos los dispositivos que se utilizan en este documento se pusieron en funcionamiento con una configuración verificada (predeterminada). Si tiene una red en vivo, asegúrese de entender el posible impacto de cualquier comando.

Acceso a la documentación de la API integrada

La documentación de la API integrada de vManage se encuentra en la dirección URL https://<vmanage_ip>:<port:>/apidocs.  Esta documentación muestra las API disponibles en la versión de software actual.

Esto requiere iniciar sesión con credenciales de vManage válidas.  Aunque varios niveles de privilegio pueden ver la documentación, sólo un usuario netadmin puede ejecutarlos todos.

Nota: la página de documentación de la API está disponible para los arrendatarios en un entorno de varios arrendatarios; sin embargo, algunos comandos están restringidos únicamente al proveedor.

vManage muestra una lista de categorías de las API disponibles.  Haga clic en la categoría deseada, seguida de la propia llamada API, que muestra estos campos:

Descripción/Notas de implementación

Descripción de la operación realizada.

Parámetros

Parámetros necesarios que se deben especificar para la llamada API.

Cuerpo de la solicitud (POST/PUT/DELETE)

Formato del cuerpo de la solicitud.

Respuestas

Posibles respuestas que vManage envía a la API.  Esto incluye el código de estado HTTP, el motivo y el posible cuerpo de la respuesta.

Extensiones

Extensiones válidas para la llamada.

Probar API desde la herramienta de documentación

Las API disponibles se pueden probar mediante la opción Try It Out.

Nota: Tenga en cuenta que no se trata de una simulación. La llamada se ejecuta en realidad en el vManage local.  Planifique cualquier impacto asociado en consecuencia.

1. Haga clic en el botón Try It Out.

2. Introduzca todos los parámetros necesarios.

3. Haga clic en Ejecutar.

Este comando realiza la tarea API y devuelve la respuesta recibida de vManage, que incluye estos campos:

Solicitar URL

La dirección URL completa que se utiliza, que incluye la dirección de vManage y los parámetros introducidos.  Esto puede ser utilizado por los scripts o utilidades aplicables que han autenticado correctamente las sesiones.

Cuerpo de respuesta

Se recibieron todos los datos de respuesta.

Código de respuesta

El código de estado HTTP recibido.

Encabezados de respuesta

Encabezados utilizados.

Información Relacionada

Documentación de la API de Cisco Developer vManage