Solicitudes de REST API de vRealize Operations

Para recuperar representaciones de objetos, los clientes realizan solicitudes HTTP a referencias de objetos.

Seguridad

El vínculo HTTP entre el servidor y el cliente de API se establece mediante SSL. Los clientes de API configuran la autenticación basada en token para comunicarse con el servidor.

Un diagrama de bloque que muestra cómo se accede a los endpoints protegidos con credenciales válidas. — Figura 1. Escenario: proporcionar credenciales de usuario para obtener detalles acerca de la alerta con el ID 123

Con la autenticación basada en token, realice una solicitud POST de inicio de sesión en el servidor de API de vRealize Operations, proporcionando credenciales de usuario válidas para obtener un token de autenticación. En el siguiente ejemplo, se muestra un escenario de autenticación basado en token.

Debe obtener las credenciales de usuario válidas para la instancia de vRealize Operations.
Realice una solicitud POST al endpoint de REST para la autenticación.
```
https://RESTendpoint.example.com/suite-api/api/auth/token/acquire
```
El cuerpo de la solicitud incluye el nombre de usuario, la contraseña y el origen de autenticación.
En el cuerpo de la respuesta, el endpoint devuelve el token, la fecha de caducidad y la hora.
Con el fin de proporcionar una mayor comunicación, incluya el objeto del token en el encabezado de autorización con el formato:
```
Authorization: vRealizeOpsToken <vROps_token>
```
Si lo prefiere, si ha adquirido el token de un origen de SSO, el encabezado de autorización deberá tener el siguiente formato:
```
Authorization: SSO2Token <SSO_SAML_TOKEN>
```
Puede anular la validez del token antes de la fecha y la hora de caducidad enviando una solicitud POST al endpoint de cierre de sesión.
```
POST https://RESTendpoint.example.com/suite-api/api/auth/token/release
```

Encabezados de solicitud

Por lo general, los siguientes encabezados HTTP se incluyen en solicitudes API:

Accept-Language	Para especificar el idioma deseado en las respuestas, utilice el encabezado de solicitud `Accept-Language`. Las cadenas de mensajes en las respuestas de ErrorType están localizadas. Para solicitar una respuesta con cadenas de mensajes localizadas en francés, utilice el siguiente encabezado: Accept-Language: fr-FR
Autorización	Todas las solicitudes para crear una sesión de API deben incluir un encabezado `Authorization` del formulario prescrito por el proveedor de identidad que utiliza su organización
Content-Type	Las solicitudes que incluyen un cuerpo deben incluir un encabezado `Content-Type` HTTP adecuado. Para un cuerpo de la solicitud en XML, el encabezado debe incluir Content-Type: application/xml Para un cuerpo de solicitud en JSON, el encabezado debe incluir Content-Type: application/json
Aceptar	Para especificar el formato de respuesta deseado, incluya el encabezado de solicitud `Accept`. Para una respuesta en XML, el encabezado debe incluir Accept: application/xml Para una respuesta en JSON, el encabezado debe incluir Accept: application/json

Solicitar cuerpos en XML

Para un cuerpo de solicitud escrito en XML, vRealize Operations utiliza un analizador XML de validación que requiere que los elementos en el cuerpo de la solicitud acepten el esquema según orden y número. Los cuerpos de la solicitud se rechazan como no válidos, a menos que cumplan los siguientes criterios:

Los atributos del espacio de nombres XML deben proporcionarse para todos los espacios de nombres representados por los elementos de la solicitud.
Si se representan varios espacios de nombres en la solicitud, los atributos del espacio de nombres XML deben incluir un prefijo de identificación y ese prefijo debe utilizarse con todos los elementos de ese espacio de nombres.
Todos los elementos necesarios deben aparecer en los cuerpos de la solicitud. Todos los elementos que aparecen en los cuerpos de la solicitud deben aparecer en el orden en el que se establece el esquema y con contenido que se ajuste a la restricción de tipo que especifica el esquema.