API Platformy All4Cloud

API Platformy All4Cloud
Luty 21, 2019 GrzegorzGiszcz

API Platformy All4Cloud znajdziemy tutaj – KLIKNIJ

Należy pamiętać, żeby:

  • Wybrać najnowszą wersję – obecnie 1.1
  • Uwierzytelnić się użytkownikiem API z odpowiednim poziomem uprawnień
  • Zapoznać się z dokumentacją dostępnych metod oraz właściwościami obiektów.

API udostępnia zbiór reguł, które pozwalają na wykonywanie operacji w obrębie:

  • Klientów
  • Faktur
  • Zamówień
  • Produktów
  • Subskrypcji

Funkcje jakie możemy zyskać przez dostęp do interfejsu REST i reguł dostarczonych przez Market Place, to między innymi automatyzacja niektórych procesów, takich jak tworzenie klientów, czy zamawianie produktów

API Market Place jak zacząć? – skontaktuj się z nami!
Aby rozpocząć korzystanie z interfejsu API na platformie należy zgłosić się do cspsupport@promise.pl
Po kontakcie z naszym wsparciem, zostanie wygenerowany użytkownik z odpowiednim poziomem dostępu.

Mam już użytkownika co dalej?

  1. Udaj się do – https://marketplace.all4cloud.pl/api/swagger/ui/index
  2. Zaloguj się przekazanymi danymi
  3. Zapoznaj się z budową poszczególnych metod dostępnych w zakładce “model”

Zaloguj się

Pierwszym krokiem po otrzymaniu danych logowania będzie uzyskanie Tokenu oAuth.
Ten krok wymaga podania danych uwierzytelniających użytkownika

Gotowe!

Wykonanie powyższych czynności pozwoli już na dostęp do gamy metod, jakie oferuje API Market Place.

Przykładowe wywołania metod

Dla przykładu poniżej zamieszczono testowe wywołania poszczególnych metod:

  • Checkdomain

Aby wysłać zapytanie, należy wybrać Check Domain i kliknąć button „wypróbuj to”

Następie uzupełnij pole body i wyślij zapytanie upewniając się czy wersja API jest najnowsza

Po  wykonaniu zapytania otrzymamy odpowiedź z serwera

  • Create Customer

Krok jakie należy wykonać są analogiczne, czyli:

  1. Wybieramy opcję “Wypróbuj to”
  2. Uzupełniamy pole “body”
  3. Upewniamy się, czy mamy wybraną najnowszą wersję API
  4. Wykonujemy zapytanie

Odpowiedź powinna w odpowiedzi zawierać:

“customerId”: “”,

  “externalCredentials”: {

    “username”: ” username “,

    “password”:” username”

  • Create Customer MCA

Aby móc zamawiać produkty dla danego klienta niezbędne jest podanie osoby fizycznej, która zaakceptowała umowę MCA – Microsoft Cloud Agreement

Create Customer MCA wymaga podania ID klienta

Odpowiedź powinna wyglądać

  • Place Order

Zamawianie produktów wygląda analogicznie do poprzednich metod

Po uzupełnieniu pola body i wykonaniu metody prawidłowo, powinniśmy zobaczyć wynik w postaci

  • Get Invoice List

Pobieranie faktur jest możliwe za pomocą metod dostępnych w grupie Invoices

Przykład wywołania:

Prawidłowa odpowiedź, powinna zwrócić wynik

 

W razie dodatkowych pytań prosimy o kontakt z opiekunem handlowym lub prosimy napisać na adres: csp@promise.pl

Podziel się