Freigeben über

App Center-API-Dokumentation

Von Bedeutung

Visual Studio App Center wurde am 31. März 2025 eingestellt, mit Ausnahme der Analyse- und Diagnosefeatures, die bis zum 30. Juni 2026 weiterhin unterstützt werden. Weitere Informationen

App Center OpenAPI-Spezifikation (Swagger)

App Center macht einen vollständigen Satz von API-Endpunkten verfügbar. Sie können die App Center-API über die OpenAPI-Spezifikation des App Center erkunden.

Mit der OpenAPI-Spezifikation des App Center können Sie sich mit Ihrem API-Token authentifizieren. Nachdem Sie authentifiziert wurden, können Sie App Center-APIs aufrufen, um mehr über die API zu erfahren und zu sehen, welche Daten zurückgegeben werden.

Tokentypen: Benutzertoken und App-Token

App Center macht zwei Arten von API-Token verfügbar: Benutzertoken und App-Token.

Benutzer-API-Token haben die gleichen Rechte wie ein Benutzer von App Center. Benutzer-API-Token funktionieren in allen Organisationen und Apps, denen Sie zugeordnet sind.

App-API-Token verfügen entweder über Manager- oder Viewerrechte, aber nur innerhalb einer App.

Jedes App Center-Konto kann bis zu 5000 API-Token erstellen.

Tipp

Es wird empfohlen, App-API-Token zu erstellen und zu verwenden, um den Autorisierungsbereich auf jeweils nur eine App zu beschränken (und das Risiko zu begrenzen, wenn ein Token verfügbar gemacht wird). Wenn Sie etwas über eine einzelne App hinaus automatisieren möchten, z. B. mit Organisationen oder freigegebenen Verteilergruppen, sollten Sie ein Benutzer-API-Token erstellen.

Warnung

Betten Sie API-Token nicht in Quellcode ein. API-Token sollten als geheime Schlüssel behandelt und sicher gespeichert werden.

Warnung

Eine Anforderung muss einen Nutzlasttext für POST/PUT/PATCH-API-Aufrufe enthalten. Verwenden Sie {} für einen leeren Nutzlastkörper, andernfalls erhalten API-Aufrufe eine 411 Length Required Fehlermeldung.

Das Erstellen eines API-Tokens für die App Center App

  1. Navigieren Sie mit Ihren Kontoanmeldeinformationen zu https://appcenter.ms und melden Sie sich an.

  2. Wählen Sie die App aus, für die Sie ein API-Token erstellen möchten.

  3. Wählen Sie auf der linken Seite "Einstellungen" aus.

  4. Wählen Sie im mittleren Bereich App-API-Token aus der Menüliste aus.

  5. Klicken Sie in der oberen rechten Ecke auf "Neues API-Token".

  6. Geben Sie im Textfeld einen beschreibenden Namen für Ihr Token ein.

  7. Wählen Sie den Zugriffstyp für Ihr App-API-Token aus:

    Vollzugriff: Ein Vollzugriffs-App-API-Token verfügt über das Äquivalent von Managerberechtigungen für diese App. Nur Manager können Vollzugriffs-App-API-Token erstellen.

    Nur-lesbar: Ein nur-lesbares App-API-Token entspricht den Viewer-Berechtigungen für diese App. Manager und Entwickler können schreibgeschützte App-API-Token erstellen.

  8. Klicken Sie unten im Bereich auf "Neues API-Token hinzufügen".

  9. Ein Popup wird mit Ihrem App-API-Token geöffnet. Kopieren und speichern Sie sie an einem sicheren Speicherort für die spätere Verwendung. Aus Sicherheitsgründen können Sie dasselbe Token nicht mehr sehen oder generieren, nachdem Sie auf die Schaltfläche " Schließen " geklickt haben.

  10. Klicken Sie auf die Schaltfläche " Schließen ".

Erstellen eines App Center-Benutzer-API-Tokens

  1. Navigieren Sie mit Ihren Kontoanmeldeinformationen zu https://appcenter.ms und melden Sie sich an.

  2. Klicken Sie in der oberen rechten Ecke des App Center-Portals auf Ihren Konto-Avatar, und wählen Sie dann "Kontoeinstellungen" aus.

  3. Wählen Sie im mittleren Bereich Benutzer-API-Token aus der Menüliste aus.

  4. Klicken Sie in der oberen rechten Ecke auf "Neues API-Token".

  5. Geben Sie im Textfeld einen beschreibenden Namen für Ihr Token ein.

  6. Wählen Sie den Zugriffstyp für Ihr Benutzer-API-Token aus:

    Vollzugriff: Ein Vollzugriffsbenutzer-API-Token verfügt über alle Berechtigungen, die Sie für das aktuelle Konto/die aktuelle Organisation besitzen. Wenn Sie beispielsweise keine Vorgesetzten- oder Entwicklerberechtigungen für eine App besitzen, kann der Benutzer keinen Test ausführen, obwohl Sie ein Benutzer-API-Token mit vollzugriff verwenden.

    Schreibgeschützt: Ein schreibgeschütztes Benutzer-API-Token verfügt über die Nur-Lesezugriffsberechtigung für das aktuelle Konto/die aktuelle Organisation. Beispielsweise können Sie mit einem schreibgeschützten Benutzer-API-Token Daten aus Abstürze, Analysen und grundlegende App-Informationen lesen. Schreibgeschützte Benutzer-API-Token können keine App-Einstellungen ändern, eine Exportkonfiguration erstellen usw.

  7. Klicken Sie unten im Bereich auf "Neues API-Token hinzufügen".

  8. Ein Popup wird mit Ihrem Benutzer-API-Token geöffnet. Kopieren und speichern Sie sie an einem sicheren Speicherort für die spätere Verwendung. Aus Sicherheitsgründen können Sie dasselbe Token nicht mehr sehen oder generieren, nachdem Sie auf die Schaltfläche " Schließen " geklickt haben.

  9. Klicken Sie auf die Schaltfläche " Schließen ".

Verwenden eines API-Tokens in einer API-Anforderung

Wenn Sie API-Anforderungen von einer Anwendung an App Center senden, müssen Sie das API-Token in den Header jeder Anforderung einschließen, die an Das App Center gesendet wird.

Übergeben Sie das API-Token in der Header-Eigenschaft der Anforderung X-API-Token.

Finden Sie Ihren App Center-App-Namen und den Besitzernamen

Einige API-Funktionen und CLI-Anforderungen von App Center erfordern einen App-Namen oder Besitzernamen als Parameter.

Beispielsweise erfordert der API-Aufruf, um den Benutzer aus der App zu entfernen, beide: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Sie können den App-Namen und den Besitzernamen aus einer App Center-URL oder über die App Center CLI finden.

Suchen von owner_name und app_name aus einer App Center-URL

  1. Navigiere zu https://appcenter.ms.
  2. Navigieren Sie zu Ihrer App.
  3. Wenn Sie sich die URL Ihrer App ansehen, befindet es sich im Format https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Der Besitzer kann ein Benutzer oder eine Organisation sein. Beispiel:

Besitzer URL Besitzername App-Name
Benutzer https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Caravan-01
Org https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers BouquetOrders App

Finde owner_name und app_name mittels der App Center CLI.

Wenn Sie die App Center CLI noch nicht installiert haben, finden Sie Installations- und Nutzungsanweisungen in der App Center CLI-Dokumentation.

Rufen Sie nach der Installation die Liste der Apps ab, auf die Sie Zugriff haben, indem Sie Folgendes ausführen:

appcenter apps list

App Center CLI zeigt eine Liste der Apps mit dem Format {owner-name}/{app-name}an.

Eine vollständige Liste der Befehlszeilenfunktionen finden Sie in der App Center CLI-Dokumentation .

Verwenden eines API-Tokens mit der OpenAPI-Spezifikation des App Center

Die OpenAPI-Spezifikation des App Center verarbeitet die API-Authentifizierung für Sie, sodass Sie das API-Token nicht in Header für Ihre Anforderungen einfügen müssen. So testen Sie App Center-APIs mit Ihrem API-Token:

  1. Navigieren Sie zur OpenAPI-Spezifikation von App Center, um unsere APIs zu erkunden.

  2. Klicken Sie in der oberen rechten Ecke auf die Schaltfläche "Autorisieren ".

  3. Fügen Sie im Abschnitt "APIToken " das API-Token in "Wert " ein, und klicken Sie auf "Autorisieren".

    Festlegen des API-Tokens zum Autorisieren der App Center-Nutzung

  4. Wenn "Autorisiert" und eine Schaltfläche "Abmelden" angezeigt wird, war die Autorisierung erfolgreich. Klicken Sie in der oberen rechten Ecke des Popups auf das "X", um das Popup zu beenden.

Erstellen Ihres ersten API-Aufrufs mit OpenAPI (Swagger)

In diesem Abschnitt wird gezeigt, wie Sie die OpenAPI-Seite des App Center mithilfe des API-Aufrufs GET /v0.1/userverwenden. Dieser API-Aufruf gibt die Profildaten des Benutzers zurück.

  1. Erstellen Sie ein API-Token, indem Sie den obigen Anweisungen folgen.
  2. Autorisieren Sie die Seite "OpenAPI-Spezifikation", um Ihr API-Token nach den Anweisungen im vorherigen Abschnitt zu verwenden.
  3. Klicken Sie unter "Konto" auf GET /v0.1/user.
  4. Klicken Sie in der linken Ecke auf die Schaltfläche "Ausprobieren" .
  5. Klicken Sie im Abschnitt "Parameter" auf die Schaltfläche "Ausführen".
  6. Prima. Die Antwort wird nun im Abschnitt "Antworten" angezeigt.

Widerrufen eines API-Tokens

Wenn ein API-Token verloren geht, sollten Sie es sofort widerrufen, um nicht autorisierten Zugriff auf Ihr App Center-Konto zu verhindern.

Widerrufen eines Benutzer-API-Tokens

  1. Navigiere zu https://appcenter.ms.
  2. Klicken Sie in der oberen rechten Ecke des App Center-Portals auf Ihren Konto-Avatar, und wählen Sie dann "Kontoeinstellungen" aus.
  3. Wählen Sie im mittleren Bereich benutzer-API-Token aus dem Menü aus.
  4. Aktivieren Sie das Kontrollkästchen neben dem Token, das Sie widerrufen möchten, und klicken Sie in der oberen rechten Ecke auf die Schaltfläche "Löschen ".

Widerrufen eines App-API-Tokens

  1. Navigiere zu https://appcenter.ms.
  2. Wählen Sie die App aus, für die Sie ein API-Token widerrufen möchten.
  3. Wählen Sie auf der linken Seite "Einstellungen" aus.
  4. Wählen Sie im mittleren Bereich app-API-Token aus dem Menü aus.
  5. Aktivieren Sie das Kontrollkästchen neben dem Token, das Sie widerrufen möchten, und klicken Sie in der oberen rechten Ecke auf die Schaltfläche "Löschen ".