API-programmering

Als gebruiker of klant van VMware Aria®Suite Lifecycle kunt u
VMware Aria Suite Lifecycle
-functies programmatisch uitvoeren via REST API-serviceaanroepen. De API volgt de REST-stijl en is beschikbaar voor alle gebruikers met een licentie.

De API-referentie

API's worden geïnstalleerd met
VMware Aria Suite Lifecycle
. De Swagger-documenten zijn beschikbaar op de volgende URL's.
  • Voor de
    VMware Aria Suite Lifecycle
    -API's gaat u naar
    https://
    $url
    /api/swagger-ui.html
  • Voor de API's voor inhoudsbeheer gaat u naar
    https://
    $url
    /lcm/cms/api/swagger-ui.html
$url
geeft de basis-URL aan voor uw instantie van
VMware Aria Suite Lifecycle
.
De
VMware Aria Suite Lifecycle
Swagger-documenten zijn ook openbaar beschikbaar op de VMware-ontwikkelaarssite. Zie VMware Aria Suite Lifecycle REST API.
VMware
geeft klanten een melding over het einde van hun levensduur van 12 maanden voor belangrijke wijzigingen in openbare API's. Als u API-wijzigingen wilt bekijken, raadpleegt u de release notes in de documentatie voor
VMware Aria Suite Lifecycle
.

Hoe ontwikkelaars de API's gebruiken

Om API-serviceaanroepen te doen, gebruikt u een browserapplicatie of een HTTP-clientapplicatie om aanvragen te verzenden en antwoorden te controleren. De volgende opensourceapplicaties worden vaak gebruikt:
Voor meer informatie over het gebruik van de API's kunt u beginnen met het uitvoeren van de stappen die worden beschreven in de volgende toepassingsvoorbeelden:
Alle toepassingsvoorbeelden bevatten
curl
-commando's in de aanvraagvoorbeelden. Als u de commando's wilt gebruiken, moet u ervoor zorgen dat de JSON-processor van de
jq
-opdrachtregel is geïnstalleerd met
curl
. De
jq
-parser zorgt ervoor dat antwoorden zijn opgemaakt voor een optimale leesbaarheid. Raadpleeg voor informatie over de installatie van
jq
https://stedolan.github.io/jq/.
Postman-verzamelingen voor
VMware Aria Suite Lifecycle
worden geleverd als voorbeelden op het tabblad
Documentatie
van de .

Verificatie

U opent
VMware Aria Suite Lifecycle
-API's als lokale gebruiker, bijvoorbeeld user@local. Lokale verificatie maakt gebruik van een basis verificatieaanvraagheader.
curl -H "Authorization: Basic <
token
>" -k https://<
LCM_hostname
>/lcm/lcops/api/settings/systemsettings
Where:
  • LCM_hostname
    de hostnaam of het IP-adres is van de
    VMware Aria Suite Lifecycle
    -server die het
    VMware Workspace ONE Access
    -cluster beheert.
  • token
    is de Base64-gecodeerde waarde voor "username:password", met de gebruikersnaam admin@local en het wachtwoord voor admin@local. Als u een Base64-indeling wilt coderen, kunt u een webapplicatie zoals https://www.base64encode.org/ gebruiken.
In het volgende aanvraagvoorbeeld ziet u hoe u een aanroep maakt met een token dat de gecodeerde waarde is van
admin@local:ThisIsPassword
.
curl -H "Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=" -k https://vrlcm.vrack.local/lcm/lcops/api/settings/systemsettings