Descripción de la API de REST

La API de REST se puede configurar en dispositivos Junos OS mediante comandos disponibles en el nivel de [edit system services rest] jerarquía. Una vez configurada, la API de REST pasa a estar disponible como servicio rest , una interfaz basada en REST que permite enviar rpc comandos al dispositivo desde una ubicación remota y admite solicitudes GET y POST. Con la API de REST puedes:

• Utilice solicitudes GET para enviar rpc comandos.

• Utilice solicitudes POST para enviar información a través de rpc comandos.

• Recupere información de configuración en XML, ASCII (texto sin formato) o JSON.

• Recupere datos operativos en XML, ASCII o JSON.

En el nivel jerárquico [edit system services rest] , puede configurar y proteger el servicio de API de REST en un dispositivo Junos OS; configurar direcciones IP, números de puerto, certificados de servidor, parámetros de control y opciones de seguimiento; y habilitar una herramienta de explorador de API de REST que le permita probar las API de REST mediante una GUI conveniente.

Están disponibles las siguientes opciones de visualización de CLI:

• Se agrega una display json opción al | (tubería) mandar. Por ejemplo, el comando show interfaces | display json de la CLI muestra las interfaces en notación JSON.

• Se agrega una format="json" opción a los comandos del servidor NETCONF para devolver información operativa en notación JSON.

La API de REST admite la autenticación básica HTTP y todas las solicitudes requieren un nombre de usuario y una contraseña codificados en base64 incluidos en el encabezado de autorización. Hay compatibilidad con HTTP y HTTPS disponibles:

• Puede utilizar HTTP para intercambiar contenido mediante texto sin cifrar si no necesita una conexión segura.

• Le recomendamos que utilice HTTPS para intercambiar contenido cifrado mediante uno de los conjuntos de cifrado disponibles. Puede configurar la API de REST para que requiera autenticación del servidor sin autenticación de cliente, o puede configurar la autenticación mutua.

Una vez que la API de REST está configurada en el dispositivo, hay nuevos puntos de conexión REST disponibles para ejecutar comandos individuales rpc a través de solicitudes GET o POST, o ejecutar varios rpc comandos a través de una sola solicitud POST. Consulte Envío de una solicitud GET a la API REST y Envío de una solicitud POST a la API REST para obtener más información.

Junos OS admite la emisión de datos de estado operativo en formato JSON compacto. Para emitir los datos JSON en formato compacto, configure la json compact instrucción en el nivel de [edit system export-format state-data] jerarquía. De lo contrario, el dispositivo emite los datos JSON en formato no compacto de forma predeterminada.

La API de REST también proporciona una GUI denominada Explorador de API de REST, que le permite aprender fácil y rápidamente a usar la API de REST. Está deshabilitado de forma predeterminada y se puede habilitar especificando set system services rest enable-explorer. Para obtener más información sobre el Explorador de API de REST, consulte Ejemplo: uso del Explorador de API de REST.