Dokumentacja interfejsu API usługi App Center

Specyfikacja interfejsu OpenAPI w usłudze App Center (Swagger)

Usługa App Center uwidacznia pełny zestaw punktów końcowych interfejsu API. Interfejs API centrum aplikacji można eksplorować za pomocą specyfikacji Interfejsu OpenAPI centrum aplikacji.

Specyfikacja interfejsu OpenAPI usługi App Center umożliwia uwierzytelnianie przy użyciu tokenu interfejsu API. Po uwierzytelnieniu możesz wywołać interfejsy API centrum aplikacji, aby dowiedzieć się więcej o interfejsie API i zobaczyć, jakie dane zwraca.

Typy tokenów: tokeny użytkownika i tokeny aplikacji

Usługa App Center uwidacznia dwa rodzaje tokenów interfejsu API: tokeny użytkownika i tokeny aplikacji.

Tokeny API użytkownika mają te same prawa, co Ty jako użytkownik App Center. Tokeny interfejsu API użytkownika działają we wszystkich organizacjach i aplikacjach, z którymi jesteś skojarzony.

Tokeny API aplikacji mają uprawnienia Administratora lub Przeglądającego, ale tylko w jednej aplikacji.

Każde konto centrum aplikacji może tworzyć maksymalnie 5000 tokenów interfejsu API.

Tworzenie tokenu API aplikacji App Center

1. Przejdź do strony https://appcenter.ms i zaloguj się przy użyciu danych konta.

2. Wybierz aplikację , dla której chcesz utworzyć token interfejsu API.

3. Po lewej stronie wybierz pozycję Ustawienia.

4. W środkowym panelu wybierz pozycję Tokeny interfejsu API aplikacji z listy menu.

5. W prawym górnym rogu kliknij pozycję Nowy token interfejsu API.

6. W polu tekstowym wprowadź opisową nazwę tokenu.

7. Wybierz typ dostępu dla tokenu interfejsu API aplikacji:

   Pełny dostęp: Token interfejsu API aplikacji z pełnym dostępem ma odpowiednik uprawnień menedżera dla tej aplikacji. Tylko menedżerowie mogą tworzyć tokeny interfejsu API aplikacji z pełnym dostępem.

   Tylko do odczytu: Token interfejsu API aplikacji tylko do odczytu ma odpowiednik uprawnień dostępu przeglądarki dla tej aplikacji. Menedżerowie i deweloperzy mogą tworzyć tokeny interfejsu API aplikacji tylko do odczytu.

8. W dolnej części panelu kliknij pozycję Dodaj nowy token interfejsu API.

9. Zostanie otwarte okno podręczne z tokenem interfejsu API aplikacji. Skopiuj i zapisz go w bezpiecznej lokalizacji do późniejszego użycia. Ze względów bezpieczeństwa nie można ponownie wyświetlić ani wygenerować tego samego tokenu po kliknięciu przycisku Zamknij .

10. Kliknij przycisk Zamknij .

Tworzenie tokenu interfejsu API użytkownika centrum aplikacji

1. Przejdź do strony https://appcenter.ms i zaloguj się przy użyciu danych konta.

2. W prawym górnym rogu portalu Centrum aplikacji kliknij awatar konta, a następnie wybierz pozycję Ustawienia konta.

3. W środkowym panelu wybierz pozycję Tokeny interfejsu API użytkownika z listy menu.

4. W prawym górnym rogu kliknij pozycję Nowy token interfejsu API.

5. W polu tekstowym wprowadź opisową nazwę tokenu.

6. Wybierz typ dostępu dla tokenu interfejsu API użytkownika:

   Pełny dostęp: Token interfejsu API użytkownika pełnego dostępu ma wszystkie uprawnienia, które masz dla bieżącego konta/organizacji. Jeśli na przykład nie masz uprawnień menedżera lub dewelopera dla aplikacji, użytkownik nie może uruchomić testu, mimo że używasz tokenu interfejsu API użytkownika pełnego dostępu.

   Tylko do odczytu: Token API użytkownika tylko do odczytu ma uprawnienia dostępu typu 'Viewer' dla bieżącego konta lub organizacji. Na przykład za pomocą tokenu API użytkownika z uprawnieniami tylko do odczytu możesz odczytywać dane z awarii, analityki i uzyskać podstawowe informacje o aplikacji. Tokeny interfejsu API użytkownika tylko do odczytu nie mogą zmieniać ustawień aplikacji, tworzyć konfiguracji eksportu itp.

7. W dolnej części panelu kliknij pozycję Dodaj nowy token interfejsu API.

8. Pojawi się wyskakujące okno z tokenem API użytkownika. Skopiuj i zapisz go w bezpiecznej lokalizacji do późniejszego użycia. Ze względów bezpieczeństwa nie można ponownie wyświetlić ani wygenerować tego samego tokenu po kliknięciu przycisku Zamknij .

9. Kliknij przycisk Zamknij .

Używanie tokenu API w żądaniu do interfejsu API

Podczas wysyłania żądań interfejsu API do centrum aplikacji należy dołączyć token interfejsu API w nagłówku każdego żądania wysłanego do centrum aplikacji.

Przekaż token interfejsu API we właściwości nagłówka X-API-Token żądania.

Znajdź nazwę swojej aplikacji w centrum aplikacji i nazwę właściciela

Niektóre funkcje interfejsu API Centrum Aplikacji i żądania CLI wymagają nazwy aplikacji lub nazwy właściciela jako parametrów.

Na przykład wywołanie interfejsu API w celu usunięcia użytkownika z aplikacji wymaga obu następujących elementów: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Nazwę aplikacji i nazwę właściciela można znaleźć w adresie URL centrum aplikacji lub przy użyciu interfejsu wiersza polecenia centrum aplikacji.

Znajdź owner_name i app_name z adresu URL App Center

1. Przejdź do strony https://appcenter.ms.
2. Przejdź do aplikacji.
3. Kiedy patrzysz na adres URL swojej aplikacji, jest on w formacie https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Właściciel może być użytkownikiem lub organizacją. Przykład:

Znajdź owner_name i app_name w App Center CLI

Jeśli jeszcze nie zainstalowano interfejsu wiersza polecenia centrum aplikacji, instrukcje dotyczące instalacji i użycia można znaleźć w dokumentacji interfejsu wiersza polecenia centrum aplikacji.

Po zainstalowaniu pobierz listę aplikacji, do których masz dostęp, uruchamiając polecenie:

appcenter apps list

Interfejs wiersza polecenia usługi App Center wyświetli listę aplikacji z formatem {owner-name}/{app-name}.

Zapoznaj się z dokumentacją interfejsu wiersza polecenia usługi App Center , aby uzyskać pełną listę funkcji wiersza polecenia.

Używanie tokenu API ze specyfikacją OpenAPI centrum aplikacji

Specyfikacja OpenAPI w App Center załatwia dla Ciebie uwierzytelnianie, więc nie musisz wklejać tokenu API do nagłówków swoich żądań. Aby przetestować interfejsy API App Center przy użyciu tokenu API:

1. Przejdź do specyfikacji interfejsu OpenAPI centrum aplikacji, aby zapoznać się z naszymi interfejsami API.

2. W prawym górnym rogu kliknij przycisk Autoryzuj .

3. W sekcji APIToken wklej token interfejsu API do Wartości i kliknij Autoryzuj.

   

4. Jeśli zostanie wyświetlony przycisk "Autoryzowane" i przycisk Wyloguj, autoryzacja zakończyła się pomyślnie. W prawym górnym rogu wyskakującego okienka kliknij przycisk "X", aby zamknąć wyskakujące okienko.

Tworzenie pierwszego wywołania interfejsu API przy użyciu interfejsu OpenAPI (Swagger)

W tej sekcji pokazano, jak używać strony OpenAPI App Center używając wywołania interfejsu API. To wywołanie interfejsu API zwraca dane profilu użytkownika.

1. Utwórz token interfejsu API, postępując zgodnie z powyższymi instrukcjami.
2. Autoryzuj stronę Specyfikacji interfejsu OpenAPI, aby używać tokenu interfejsu API zgodnie z instrukcjami w poprzedniej sekcji.
3. W obszarze Konto kliknij pozycję GET /v0.1/user.
4. W lewym rogu kliknij przycisk Wypróbuj .
5. Kliknij przycisk Wykonaj w sekcji Parametry .
6. Świetnie! Teraz możesz zobaczyć odpowiedź w sekcji Odpowiedzi .

Cofanie tokenu interfejsu API

W przypadku wycieku tokenu interfejsu API należy natychmiast odwołać go, aby zapobiec nieautoryzowanemu dostępowi do konta centrum aplikacji.

Odwoływania tokenu interfejsu API użytkownika

1. Przejdź do strony https://appcenter.ms.
2. W prawym górnym rogu portalu Centrum aplikacji kliknij awatar konta, a następnie wybierz pozycję Ustawienia konta.
3. W środkowym panelu wybierz pozycję Tokeny interfejsu API użytkownika z menu.
4. Zaznacz pole wyboru obok tokenu, który chcesz odwołać, i kliknij przycisk Usuń w prawym górnym rogu.

Odwoływania tokenu interfejsu API aplikacji

1. Przejdź do strony https://appcenter.ms.
2. Wybierz aplikację , dla której chcesz odwołać token interfejsu API.
3. Po lewej stronie wybierz pozycję Ustawienia.
4. W środkowym panelu wybierz pozycję Tokeny interfejsu API aplikacji z menu.
5. Zaznacz pole wyboru obok tokenu, który chcesz odwołać, i kliknij przycisk Usuń w prawym górnym rogu.