VMware Aria Operations Solicitações REST de API

Para recuperar representações de objeto, os clientes fazem solicitações HTTP para referências de objeto.

Segurança

O link HTTP entre um cliente de API e um servidor é estabelecido usando SSL. Os clientes de API configuram a autenticação baseada em token para se comunicar com o servidor.

Um diagrama de blocos mostrando como endpoints protegidos são acessados com credenciais válidas. — Figura 1. Cenário: fornecer credenciais de usuário para obter detalhes sobre o alerta com a ID 123

Com a autenticação baseada em token, você POST uma solicitação de login para o servidor de API VMware Aria Operations, fornecendo credenciais de usuário válidas para obter um token de autenticação. O exemplo a seguir apresenta um cenário de autenticação baseada em token.

Você obtém credenciais de usuário válidas para sua instância do VMware Aria Operations.
POST uma solicitação ao endpoint REST para autenticação.
```
https://RESTendpoint.example.com/suite-api/api/auth/token/acquire
```
O corpo da solicitação inclui o nome de usuário, a senha e a fonte de autenticação.
No corpo da resposta, o endpoint retorna o token, a data de validade e a hora.
Para comunicação adicional, inclua o objeto token no cabeçalho Authorization com o formato :
```
Authorization: OpsToken <vROps_token>
```
Observação: O formato antigo,
```
Authorization: vRealizeOpsToken <vROps_token>
```
continua a ser suportado em VMware Aria Operations.
Como alternativa, se você tiver adquirido o token de uma fonte de SSO, o cabeçalho Authorization terá o formato:
```
Authorization: SSO2Token <SSO_SAML_TOKEN>
```
Você pode invalidar o token antes da data e hora de expiração enviando uma solicitação POST para o endpoint de logout.
```
POST https://RESTendpoint.example.com/suite-api/api/auth/token/release
```

Solicitar cabeçalhos

Os seguintes cabeçalhos HTTP normalmente são incluídos nas solicitações de API:

Accept-Language	Para especificar o idioma desejado nas respostas, use o cabeçalho de solicitação `Accept-Language`. As cadeias de caracteres de mensagens nas respostas ErrorType são localizadas. Para solicitar uma resposta com cadeias de caracteres de mensagem localizadas em francês, use o seguinte cabeçalho: Accept-Language: fr-FR
Autorização	Todas as solicitações para criar uma sessão de API devem incluir um cabeçalho `Authorization` do formulário prescrito pelo provedor de identidade que sua organização usa
Tipo de Conteúdo	As solicitações que incluem um corpo devem incluir um cabeçalho HTTP `Content-Type` apropriado. Para um corpo de solicitação em XML, o cabeçalho deve incluir Content-Type: application/xml Para um corpo de solicitação em JSON, o cabeçalho deve incluir Content-Type: application/json
Aceitar	Para especificar o formato de resposta desejado , inclua o cabeçalho de solicitação `Accept`. Para uma resposta em XML, o cabeçalho deve incluir Accept: application/xml Para uma resposta em JSON, o cabeçalho deve incluir Accept: application/json

Solicitar corpos em XML

Para um corpo de solicitação escrito em XML, o VMware Aria Operations usa um analisador XML de validação que exige que os elementos em um corpo de solicitação concordem com o esquema em ordem e número. Os corpos da solicitação são rejeitados como inválidos, a menos que atendam aos seguintes critérios:

Os atributos de namespace XML devem ser fornecidos para todos os namespaces representados por elementos na solicitação.
Se vários namespaces forem representados na solicitação, os atributos de namespace XML deverão incluir um prefixo de identificação, e esse prefixo deverá ser usado com todos os elementos desse namespace.
Todos os elementos necessários devem aparecer nos corpos da solicitação. Todos os elementos que aparecem nos corpos da solicitação devem aparecer na ordem estabelecida pelo esquema e com conteúdo que esteja em conformidade com a restrição de tipo especificada pelo esquema.