Programação de APIs

Como usuário ou cliente do VMware Aria®Suite Lifecycle, você pode executar
VMware Aria Suite Lifecycle
funções de forma programática usando chamadas de serviço de REST APIs. A API segue o estilo REST e está disponível para todos os usuários licenciados.

Sobre a referência de APIs

As APIs são instaladas com o
VMware Aria Suite Lifecycle
. Os documentos do Swagger estão disponíveis nas seguintes URLs.
  • Para as APIs do
    VMware Aria Suite Lifecycle
    , acesse
    https://
    $url
    /api/swagger-ui.html
  • Para as APIs de Gerenciamento de Conteúdo, acesse
    https://
    $url
    /lcm/cms/api/swagger-ui.html
$url
indica o URL de base para sua instância do
VMware Aria Suite Lifecycle
.
Os documentos do
VMware Aria Suite Lifecycle
Swagger também estão disponíveis publicamente no site de desenvolvedores da VMware. Consulte .
A
VMware
fornece aos clientes um aviso de fim de vida útil de 12 meses para quaisquer alterações significativas nas APIs públicas. Para revisar as alterações na API, consulte as notas de versão incluídas na Documentação do
VMware Aria Suite Lifecycle
.

Como os desenvolvedores usam as APIs

Para fazer chamadas de serviço de API, você usa um aplicativo de navegador ou um aplicativo cliente HTTP para enviar solicitações e analisar respostas. Os seguintes aplicativos de código aberto são comumente usados:
Para saber como usar as APIs, você pode começar executando as etapas descritas nos casos de uso a seguir:
Todos os casos de uso incluem comandos
curl
em exemplos de solicitação. Para usar os comandos, certifique-se de que o processador JSON de linha de comando
jq
esteja instalado com
curl
. O analisador
jq
garante que as respostas sejam formatadas para facilitar a leitura. Para obter informações sobre a instalação dde
jq
, consulte https://stedolan.github.io/jq/.
Coleções do Postman para o
VMware Aria Suite Lifecycle
são fornecidas como exemplos na guia
Documentação
do .

Autenticação

Você acessa as APIs do
VMware Aria Suite Lifecycle
como um usuário local, por exemplo, user@local. A autenticação local usa um cabeçalho básico de solicitação de autorização.
curl -H "Authorization: Basic <
token
>" -k https://<
LCM_hostname
>/lcm/lcops/api/settings/systemsettings
Where:
  • LCM_hostname
    é o nome do host ou o endereço IP do
    VMware Aria Suite Lifecycle
    servidor que gerencia o cluster do
    VMware Workspace ONE Access
    .
  • token
    é o valor codificado em Base64 de “username:password”, com o nome de usuário admin@local e a senha de admin@local. Para codificar para o formato Base64, você pode usar um aplicativo da Web, como o https://www.base64encode.org/.
O exemplo de solicitação a seguir mostra como fazer uma chamada com um token que é o valor codificado de
admin@local:ThisIsPassword
.
curl -H "Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=" -k https://vrlcm.vrack.local/lcm/lcops/api/settings/systemsettings