Szybkie wprowadzene do API Platformy

Niniejszy artykuł przedstawia w możliwie skondensowanej formie podstawowe informacje na temat wykorzystania API Platform do wykonania podstawowych operacji zarządzania.

Terminologia

Wykorzystywane w dokumencie pojęcia oznaczają:

  • Użytkownik przeznaczony jest do zarządzania zasobami platformy przez osoby fizyczne. Wykorzystuje platformę do zarządzania Zasobami np. poprzez CLI lub panel. Więcej informacji w artykule Użytkownik.
  • Projekt przeznaczony jest do logicznego zgrupowania zasobów, którego dla Organizacji mają wspólny cel i przeznaczenie. Więcej informacji w artykule Projekt.
  • Zasób stanowi obiekt w infrastrukturze Platformy, z którym Użytkownik może współdziałać i go modyfikować. Więcej informacji w artykule Zasób.
  • Konto usługi to dane dostępowe umożliwiające wykonywanie modyfikacji Zasobów Projektu w imieniu Użytkownika przez aplikacje tj. skrypty, urządzenia lub inne procesy automatyzujące. Przypisany jest zawsze do jednego Projektu. Więcej w sekcji Konto Usługi artykułu Projekt.

Komunikacja z API Platformy z wykorzystaniem 'curl' lub 'Powershell'

W celu bezpośredniego dostępu do API Platformy rekomendujemy wykorzystanie Konta Usługi. W celu wykorzystania Konta Usługi pierw utwórz Konto Usługi oraz zachowaj jego identyfikator.

W celu ustalenia sposobu sformułowania żądania do Platformy odszukaj odpowiednią akcje w dokumentacji referencyjnej API Platformy.

W dalszych krokach zostanie przedstawione utworzenie, uzyskanie listy i skasowanie Vault jako przykład operacji.

Otrzymany token musi zostać użyty w nagłówku HTTP ```x-auth-token, aby upewnić się, że Twoje połączenie HTTP będzie autoryzowane przez Platformę:

curl -X POST https://api.rootbox.com/v1/vault -H 'x-auth-token: 5bacb27a70db5c0bf4e5dce0' -H "Content-Type: application/json" -d'{"name":"test-vault", "size":25}'
$params = @{"name"="test-vault"; "size"=25; }
$vault = Invoke-RestMethod `
    -Headers @{ 'x-auth-token' = "5bacb27a70db5c0bf4e5dce0" } `
    -Body ($params|ConvertTo-Json) -ContentType "application/json" `
    "https://api.hyperone.com/v1/vault" 
$vault | Select *

W odpowiedzi otrzymasz dokument JSON, który będzie zawierać informacje o nowo utworzony Zasobie. W prosty sposób możesz uzyskać listę Zasobów:

curl https://api.hyperone.com/v1/vault -H 'x-auth-token: 5bacb27a70db5c0bf4e5dce0' -H "Content-Type: application/json"
$vault_list = Invoke-RestMethod `
    -Headers @{ 'x-auth-token' = "5bacb27a70db5c0bf4e5dce0" } `
    -ContentType "application/json" `
    "https://api.hyperone.com/v1/vault" 
$vault_list | foreach { Write-Host $_.name }

Jak również - wykorzystując wcześniej otrzymany identyfikator Zasobu - usunąć nowo utworzony Zasób tj. Vault:

curl -X DELETE https://api.hyperone.com/v1/vault/5c3f5ab25ceadc3d412ba41d -H 'x-auth-token: 5bacb27a70db5c0bf4e5dce0' -H "Content-Type: application/json"
Invoke-RestMethod `
    -CustomMethod DELETE `
    -Headers @{ 'x-auth-token' = "5bacb27a70db5c0bf4e5dce0" } `
    -ContentType "application/json" `
    "https://api.hyperone.com/v1/vault/$($vault._id)" 
Czy uważasz ten artykuł za przydatny? Tak Nie