Citrix SD-WAN Orchestrator para entornos locales 14.3

Guía de API para Citrix SD-WAN Orchestrator for On-premises

Para acceder a la guía de API de Citrix SD-WAN Orchestrator for On-premises en la interfaz de usuario de Swagger:

  1. Inicie sesión en Citrix SD-WAN Orchestrator for On-premises y haga clic en ? en la esquina superior derecha de la interfaz de usuario y, a continuación, en Guía de API.

    Icono de API

    Se muestran los detalles de la especificación Swagger.

    Icono de API

  2. Haga clic en la URL de especificación de Swagger para acceder a la guía de API.

Citrix SD-WAN Orchestrator para API locales a través de curl

Requisitos previos

  • Acceso a la nube
  • Inicio de sesión local

Realice los siguientes pasos para usar las API de Citrix On-premises Orchestrator a través de curl:

  1. Inicio desesión en la nube: En el caso de un XVA nuevo, primero debe iniciar sesión en la nube.

    curl -k -X POST -H "Content-Type: application/json "https://<onprem-orchestrator-ip>/policy/v1/onprem/cloudLogon –data '{"clientId":"<clientId>","clientSecret":"<clientSecret> ","ccId":"<ccid>", "pop": "<popName>"}'
    

    clientId, clientSecret y ccId se pueden obtener en la página de IAM.

    Nota

    Asegúrese de que la cuenta del cliente ya esté creada en la nube antes de intentar iniciar sesión en la nube.

  2. Inicio desesión local: A continuación, inicie sesión local para obtener el token de autenticación.

    curl -k -X POST -H "Content-Type: application/json" https://<onprem-orchestrator-ip>/onpm/v1/logon --data '{"username":"admin","password":"<passwordField>"}'
    

    Esto devuelve el token y el ID de cliente en respuesta. El CustomerID permanece fijo y es necesario en otras llamadas a la API. Guarde el CustomerID para usarlo más adelante. El token sigue siendo válido durante una hora. Más adelante, debe realizar un nuevo inicio de sesión.

    Ejemplo: Utilice el token de autenticación y el ID de cliente para activar otras API locales de Citrix.

    curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings
    
Guía de API para Citrix SD-WAN Orchestrator for On-premises