Pierwsze kroki z API OVHcloud

Wprowadzenie

API dostępne na stronie https://api.ovh.com/ pozwalają na zakup, zarządzanie i konfigurowanie produktów OVHcloud bez konieczności korzystania z interfejsu graficznego, takiego jak Panel klienta.

Dowiedz się, jak korzystać z API OVHcloud oraz jak je łączyć z Twoimi aplikacjami

Wymagania początkowe

• Posiadanie aktywnego konta OVHcloud i znanie jego identyfikatorów
• Bycie na stronie WWW API OVHcloud.

W praktyce

Proste użytkowanie

Logowanie do API OVHcloud

Na stronie API OVHcloud kliknij Explore the OVH API, aby wyświetlić listę API.

Aby korzystać z API na produktach, należy zalogować się na tej stronie za pomocą identyfikatora OVHcloud.

• W lewym górnym rogu kliknij przycisk Authentication.
• Następnie kliknij Login with OVHcloud SSO.
• Wpisz dane dostępowe OVHcloud.
• Kliknij przycisk Authorize, aby zezwolić na wywołania API z tej strony.

Sprawdź produkty dostępne na API

W menu po lewej stronie znajduje się lista produktów OVHcloud, którymi można zarządzać za pomocą API.

Aby wyświetlić na przykład API powiązane z domenami, kliknij na /domain na liście.

Po kliknięciu na produkt lista API tego produktu wyświetla się poniżej.

Możesz również skorzystać z przycisku znajdującego się po lewej stronie listy produktów, aby wybrać gałąź /v1 i /v2 API. Jeśli nie znasz zasad gałęzi API, zapoznaj się z następującą dokumentacją dotyczącą API v2.

Uruchom API

Dostępne są 4 rodzaje API, które wykorzystują tak zwane metody HTTP:

GET

Metoda GET ma na celu odzyskanie danych z zasobu.

Na przykład, aby pobrać listę Twoich domen, użyj następującego API:

POST

Metoda POST jest wykorzystywana do wysyłania dodatkowych danych do zasobu.

Na przykład, aby dodać rekord do strefy DNS, użyj następującego API:

PUT

Metoda PUT służy do zastąpienia aktualnych danych dotyczących zasobu danymi zapytania.

Na przykład, jeśli popełniłeś błąd podczas zapisywania strefy DNS, użyj następującego API:

DELETE

Metoda DELETE jest używana do usuwania nazwanego zasobu.

Na przykład, jeśli nie chcesz zachować rekordu DNS, który dodałeś do strefy DNS, użyj następującego API:

Parametry API

Po kliknięciu na API w wybranej przez Ciebie sekcji Request możesz przypisać zmienne związane z aplikacją.

Na przykład, aby dodać rekord TXT do strefy DNS, zoptymalizujesz następujące parametry:

Po zdefiniowaniu ustawień możesz uruchomić API klikając EXECUTE.

W zakładce Response wyświetli się raport z realizacji API.

Zakładki PHP i Python zawierają elementy, które należy dodać do skryptu w zależności od używanego języka.

Zaawansowane wykorzystanie: łączenie API OVHcloud z aplikacją

Utwórz klucze aplikacji

Każda aplikacja, która chce komunikować się z API OVHcloud, musi zostać zgłoszona z wyprzedzeniem.

W tym celu kliknij link: https://eu.api.ovh.com/createToken/.

Wpisz identyfikator klienta, hasło i nazwę aplikacji. Nazwa będzie pomocna później, jeśli chcesz zezwolić innym na jej używanie.

Możesz również dodać opis aplikacji oraz czas jej trwania.

Zakres Rights pozwala na ograniczenie korzystania z aplikacji do niektórych API.
Aby zezwolić wszystkim API OVHcloud dla metody HTTP, wprowadź gwiazdkę * w polu, jak w poniższym przykładzie, w którym metoda GET jest dozwolona dla wszystkich API:

Po kliknięciu Create keys otrzymasz trzy klucze:

• Klucz aplikacji zwany AK. Przykład:

7kbG7Bk7S9Nt7ZSV

• klucza aplikacji, który nie zostanie ujawniony, o nazwie AS. Przykład:

EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF

• tajnej "consumer key", której nie ujawnia się, zwanej CK. Przykład:

MtSwSrPpNjqfVSmJhLbPyr2i45lSwPU1

W tym przypadku klucz CK jest przypisany do Twojego konta.

Token CK może być wykorzystywany do przekazywania uprawnień. Więcej informacji znajdziesz w przewodniku: Jak zarządzać kontem klienta OVHcloud za pomocą API (przewodnik po języku angielskim).

Pierwsze wykorzystanie API

Po uzyskaniu trzech kluczy (AK, AS, CK) możesz podpisać zlecenia API. Podpis oblicza się w następujący sposób:

"$1$" + SHA1_HEX(AS+"+"+CK+"+"+METHOD+"+"+QUERY+"+"+BODY+"+"+TSTAMP)

Aby uprościć programowanie aplikacji, OVHcloud udostępnia wrappery API w kilku językach. Dzięki nim nie będziesz martwił się o obliczenia podpisu i będziesz mógł skupić się na rozwoju Twojej aplikacji.

• Perl : https://github.com/ovh/perl-ovh
• Python : https://github.com/ovh/python-ovh
• PHP : https://github.com/ovh/php-ovh
• Node.js : https://github.com/ovh/node-ovh
• Swift : https://github.com/ovh/swift-ovh
• C# : https://github.com/ovh/csharp-ovh

Przykład zastosowania sekcji /me, która pozwala na zarządzanie kontem OVHcloud:

import ovh

# Instantiate. Visit https://api.ovh.com/createToken/?GET=/me
# to get your credentials
client = ovh.Client(
    endpoint='ovh-eu',
    application_key='<application key>',
    application_secret='<application secret>',
    consumer_key='<consumer key>',
)

# Print nice welcome message
print("Welcome", client.get('/me')['firstname'])

Tworzenie listy i usuwanie kluczy

Do wyświetlania i odwoływania kluczy możesz użyć portalu API lub panelu klienta OVHcloud:

Poprzez portal API OVHcloud

W Panelu klienta OVHcloud

• Wyświetl identyfikatory kluczy, korzystając z następującego wywołania:

🇪🇺EU▾

GET/me/api/application

- Uzyskaj szczegóły klucza za pomocą następującego wywołania:

🇪🇺EU▾

GET/me/api/application/{applicationId}

- Unieważnij klucz za pomocą następującego wywołania:

🇪🇺EU▾

DELETE/me/api/application/{applicationId}

Przejdź do strony Klucze API.

Sprawdź również

Zarządzanie domeną poprzez API OVHcloud (przewodnik po angielsku)

Jak zarządzać kontem klienta OVHcloud za pomocą API (przewodnik po angielsku)

Przyłącz się do społeczności naszych użytkowników na stronie https://community.ovh.com/en/