Cisco que hace frente a las funciones básicas del servidor API

Transcripción

1 Cisco que hace frente a las funciones básicas del servidor API Contenido Introducción prerrequisitos Requisitos Componentes Utilizados Antecedentes Petición y respuesta API Configurar HTTP POST HTTP GET HTTP PUESTO CANCELACIÓN HTTP Clientes API CARTEL CARTERO Verificación Troubleshooting Introducción Este documento describe las cuatro funciones básicas GET API (interfaz de programación de aplicaciones), POSTE, PUSO, BORRA utilizado en CMS (Cisco que encuentra el servidor). También describe dos diversas herramientas API: Cartel y cartero y cómo utilizarlas para la configuración CMS. Contribuido por Vernon Depee, ingeniero de Cisco TAC. Prerrequisitos Requisitos No hay requisitos específicos para este documento. Componentes Utilizados Este documento no tiene restricciones específicas en cuanto a versiones de software y de hardware. La información en este documento puede ser uso con diversos clientes API como el cartero o el cartel. Estas herramientas se describen en la sección de los clientes API del documento.

2 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 la red está funcionando, asegúrese de haber comprendido el impacto que puede tener cualquier comando. Antecedentes El API para CMS es extremadamente una manera flexible de configurar muchas de sus características. Hay lejano demasiadas características API a memorizar o cubrir aquí, esté tan seguro de referirse a la documentación de referencia actual API. A partir de la época de esta escritura, los guías de referencia actuales API están disponibles aquí. Petición y respuesta API La comunicación API es una relación de la petición-respuesta entre los clientes y servidores. El cliente hace una petición del servidor. Después de manejar la petición (completando una acción, o rechazando hacer tan) se vuelve una respuesta. Las peticiones descritas en este artículo son cuatro: 1. GET - Extrae la información existente 2. POSTE - Crea la nueva información 3. PONGA - Modifica la información existente 4. CANCELACIÓN - Borra la información existente. Éstos son el uso básico de las peticiones API de configurar CMS. La respuesta más común es una AUTORIZACIÓN 200. Otras respuestas son 4xx y 5xx, eso son respuestas de error. Configurar Las cuatro peticiones básicas se explican con un ejemplo de configuración. HTTP POST

3 Paso 1. Utilice el POSTE para crear un objeto. En este ejemplo, un espacio de CMS se crea usando esta petición. Para crear el espacio vía el API consulte la documentación API. Por este ejemplo la guía específica usada es ésta. El índice dice la sección 6.2 tiene información sobre cómo crear y modificar un cospace. La primera frase dice eso para crear un espacio, usted necesita enviar un poste a /cospaces. Entonces, dice el ID del espacio estará en el encabezado Location de la AUTORIZACIÓN 200. Grande, usted ahora sabe crear un espacio. Usted apenas envía un POSTE a Especifique los parámetros para el POSTE. En la sección 6.2 del documetnation usted ve una tabla que enumere todos los parámetros que usted puede utilizar. Por ejemplo: Cree un espacio con el nombre APITest y una parte de APITestURI del usuario de URI El tipo de contenido es application/x-www-form-urlencoded y el contenido es name=apitest&uri=apitesturi Cuando usted agrega este los parámetros la petición es completa, tal y como se muestra en de la imagen. POST HTTP/1.1 Host: <WebAdminIP> Content-Type: application/x-www-form-urlencoded Content-Length: 27

4 Authorization: Basic YWRtaW46QzFzYzBDMXNjMA== Connection: keep-alive name=apitest&uri=apitesturi La imagen muestra una respuesta al pedido anterior. HTTP/ OK Server: Apache X-Frame-Options: DENY Strict-Transport-Security: max-age= ; includesubdomains Vary: Accept-Encoding Content-Encoding: gzip Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Note el encabezado Location en la respuesta. 70ca0ed7-4e50-428c-b9ab-4e68faeb86ae es el ID del nuevo espacio creado. El ID es útil cuando usted necesita hacer el futuro API pide que apunta el mismo espacio. El espacio se puede considerar en el WebAdmin de CMS. Navegue a la configuración > a los espacios. La imagen resume el POSTE de la petición. HTTP GET Paso 2. Después de que se haya creado el espacio, tire de la configuración para ella.

5 Utilice el para este propósito del método HTTP GET. Utilice el ID para el espacio creado del encabezado Location. El URL es Realice un GET en esta página. Petición get del ejemplo: Respuesta para la petición get: Note: El resposne es una configuración codificada XML del espacio. La imagen resume la petición GET HTTP PUESTO Paso 3. Realice un cambio al espacio (si es necesario). Este ejemplo muestra cómo modificar el espacio creado. Imagínese que una porción secundaria del usuario necesita ser agregada al espacio. Refiera al documento API. Dice el parámetro necesario para utilizar que es: secondaryuri. Agregue URI del asdf. Escriba una petición que parezca similar a la petición creada para el POSTE.

6 Petición PUESTA ejemplo: Respuesta para la petición PUESTA: Los cambios se pueden considerar en el WebAdmin de CMS. Navegue a la configuración > a los espacios. y vía un GET: La imagen resume la petición PUESTA CANCELACIÓN HTTP Paso 4. Borre el espacio (si es necesario). El método Delete es similar al método GET. Petición de la CANCELACIÓN del ejemplo: Respuesta para el DELETErequest:

7 Los cambios se pueden considerar en el WebAdmin de CMS. Navegue a la configuración > a los espacios. y vía un GET: La imagen resume la CANCELACIÓN de la petición Clientes API CARTEL El rectángulo superior en el cartel es donde usted ingresa el URL para las peticiones. Los campos del auth del usuario son donde usted ingresa el nombre de usuario y contraseña en esa orden. Entonces, si usted está haciendo un GET o una CANCELACIÓN, seleccione los botones respectivos. Por ejemplo: haga clic en el GET y un popup aparece con su respuesta. Para la CANCELACIÓN, asegure que la CANCELACIÓN está seleccionada y haga clic el botón verde.

8 Para el POSTE y PUESTO, contente las necesidades de ser agregado. Seleccione la lengueta de los parámetros y agregue los nombres y los valores para sus parámetros. Entonces, vuelva al contenido enviar el botón y seleccionar el cuerpo de los parámetros. Envíe su POSTE y/o PONGA. CARTERO En el cartero, en la superior izquierda seleccione el método que usted quisiera utilizar de la casilla desplegable y ingresar la petición URL. Para la autorización, el Básico-auth selecto y ingresa su nombre de usuario y contraseña. Entonces, petición selecta de la actualización. En la lengueta de las encabezados usted ve una encabezado de la autorización. Si su petición es un POST/PUT, navegue a la lengueta del cuerpo, seleccione la x-www-formaurlencoded y ingrese sus parámetros y valores. Cuando le hacen, selecto envíe.

9 Verificación La manera de verificar los cambios realizados se explica en cada petición. Troubleshooting Actualmente, no hay información específica de troubleshooting disponible para esta configuración.