次の方法で共有

App Center API のドキュメント

重要

Visual Studio App Center は、2026 年 6 月 30 日まで引き続きサポートされる分析機能と診断機能を除き、2025 年 3 月 31 日に廃止されました。 詳細を参照してください。

App Center OpenAPI 仕様 (Swagger)

App Center では、API エンドポイントの完全なセットが公開されます。 App Center の OpenAPI 仕様を使用して、App Center API を調べることができます。

App Center OpenAPI 仕様では、API トークンを使用して認証できます。 認証が完了したら、App Center API を呼び出して API について学習し、返されるデータを確認できます。

トークンの種類: ユーザー トークンとアプリ トークン

App Center では、ユーザー トークンとアプリ トークンの 2 種類の API トークンが公開されています。

ユーザー API トークンには、App Center のユーザーと同じ権限があります。 ユーザー API トークンは、関連付けられているすべての組織とアプリで機能します。

アプリ API トークンには、マネージャーまたはビューアーのいずれかの権限がありますが、1 つのアプリ内でのみ使用できます。

各 App Center アカウントでは、最大 5,000 個の API トークンを作成できます。

ヒント

アプリ API トークンを作成して使用して、承認スコープを一度に 1 つのアプリのみに制限することをお勧めします (トークンが公開された場合のリスクを制限します)。 組織や共有配布グループの操作など、1 つのアプリ以外のものを自動化する必要がある場合は、ユーザー API トークンを作成する必要があります。

警告

API トークンをソース コードに埋め込むことはありません。 API トークンはシークレットとして扱い、安全に格納する必要があります。

警告

要求には、POST/PUT/PATCH API 呼び出しのペイロード本文が含まれている必要があります。 空のペイロード本文に{}を使用しないと、API 呼び出しは411 Length Requiredエラー応答を受け取ります。

App Center App API トークンの作成

  1. https://appcenter.msに移動し、アカウントの資格情報を使用してサインインします。

  2. API トークンを作成するアプリを選択します。

  3. 左側で、[ 設定] を選択します。

  4. 中央のパネルで、メニューの一覧から [アプリ API トークン ] を選択します。

  5. 右上隅にある [ 新しい API トークン] をクリックします。

  6. テキスト フィールドに、トークンのわかりやすい名前を入力します。

  7. アプリ API トークンのアクセスの種類を選択します。

    フル アクセス: フル アクセスのアプリ API トークンには、そのアプリに対するマネージャーアクセス許可と同等のものがあります。 フル アクセスのアプリ API トークンを作成できるのは、マネージャーだけです。

    読み取り専用: 読み取り専用のアプリ API トークンには、そのアプリのビューアー アクセス許可と同等のアクセス許可があります。 マネージャーと開発者は、読み取り専用のアプリ API トークンを作成できます。

  8. パネルの下部にある [ 新しい API トークンの追加] をクリックします。

  9. アプリ API トークンを含むポップアップが開きます。 後で使用できるように、セキュリティで保護された場所にコピーして保存 します。 セキュリティ上の理由から、[ 閉じる ] ボタンをクリックした後、同じトークンを再度表示または生成することはできません。

  10. [ 閉じる ] ボタンをクリックします。

App Center ユーザー API トークンの作成

  1. https://appcenter.msに移動し、アカウントの資格情報を使用してサインインします。

  2. App Center ポータルの右上隅で、アカウントのアバターをクリックし、[ アカウント設定] を選択します。

  3. 中央のパネルで、メニュー一覧から [ユーザー API トークン ] を選択します。

  4. 右上隅にある [ 新しい API トークン] をクリックします。

  5. テキスト フィールドに、トークンのわかりやすい名前を入力します。

  6. ユーザー API トークンのアクセスの種類を選択します。

    フル アクセス: フル アクセスユーザー API トークンには、現在のアカウント/組織に対して持っているすべてのアクセス許可があります。 たとえば、アプリのマネージャーまたは開発者のアクセス許可がない場合、フル アクセスのユーザー API トークンを使用している場合でも、ユーザーはテストを実行できません。

    読み取り専用: 読み取り専用のユーザー API トークンには、現在のアカウント/組織に対するビューアー アクセス許可があります。 たとえば、読み取り専用のユーザー API トークンを使用すると、クラッシュからデータを読み取り、分析し、基本的なアプリ情報を取得できます。 読み取り専用のユーザー API トークンでは、アプリの設定を変更したり、エクスポート構成を作成したりすることはできません。

  7. パネルの下部にある [ 新しい API トークンの追加] をクリックします。

  8. ポップアップが開き、ユーザー API トークンが表示されます。 後で使用できるように、セキュリティで保護された場所にコピーして保存 します。 セキュリティ上の理由から、[ 閉じる ] ボタンをクリックした後、同じトークンを再度表示または生成することはできません。

  9. [ 閉じる ] ボタンをクリックします。

API 要求での API トークンの使用

アプリケーションから App Center に API 要求を送信する場合は、App Center に送信されるすべての要求のヘッダーに API トークンを含める必要があります。

要求の X-API-Token ヘッダー プロパティで API トークンを渡します。

App Center アプリ名と所有者名を見つける

App Center の API 関数と CLI 要求の一部では、パラメーターとしてアプリ名または所有者名が必要です。

たとえば、アプリからユーザーを削除する API 呼び出しには、 DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}の両方が必要です。

アプリ名と所有者名は、App Center URL から、または App Center CLI を使用して検索できます。

App Center URL からowner_nameとapp_nameを検索する

  1. https://appcenter.ms に移動します。
  2. アプリに移動します。
  3. アプリの URL を確認すると、 https://appcenter.ms/users/{owner-name}/apps/{app-name}形式になります。

所有者には、ユーザーまたは組織を指定できます。 例えば次が挙げられます。

オーナー URL 所有者名 アプリ名
ユーザー https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst キャラバン-01
組織 https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers ブーケ注文アプリ

App Center CLI から、owner_name と app_name を見つける

App Center CLI をまだインストールしていない場合は、インストールと使用の手順については、 App Center CLI のドキュメントを参照してください。

インストールしたら、次のコマンドを実行して、アクセス権を持つアプリの一覧を取得します。

appcenter apps list

App Center CLI には、 {owner-name}/{app-name}形式のアプリの一覧が表示されます。

コマンド ライン関数の完全な一覧については、 App Center CLI のドキュメント を参照してください。

App Center OpenAPI 仕様での API トークンの使用

App Center OpenAPI 仕様では API 認証が自動的に処理されるため、要求のヘッダーに API トークンを貼り付ける必要はありません。 API トークンを使用して App Center API をテストするには:

  1. App Center の OpenAPI 仕様 に移動して、API を確認します。

  2. 右上隅にある [ 承認 ] ボタンをクリックします。

  3. [ APIToken ] セクションで、API トークンを [値 ] に貼り付け、[ 承認] をクリックします。

    App Center の使用を承認するための API トークンの設定

  4. [承認済み] ボタンと [ログアウト] ボタンが表示されている場合、承認は成功しました。 ポップアップの右上隅にある [X] をクリックしてポップアップを終了します。

OpenAPI (Swagger) を使用して最初の API 呼び出しを行う

このセクションでは、API 呼び出しを使用して App Center の GET /v0.1/userを使用する方法について説明します。 この API 呼び出しは、ユーザーのプロファイル データを返します。

  1. 上記の手順に従って API トークンを作成 します。
  2. 前のセクションの手順に従って、API トークンを使用するように OpenAPI 仕様ページを承認します。
  3. [ アカウント] で、 GET /v0.1/userをクリックします。
  4. 左側の隅にある [ 試してみる ] ボタンをクリックします。
  5. [パラメーター] セクションの下にある [実行] ボタンをクリックします。
  6. すごいですね。 [応答] セクションに 応答が 表示されます。

API トークンの取り消し

API トークンが漏洩した場合は、App Center アカウントへの不正アクセスを防ぐために、すぐに取り消す必要があります。

ユーザー API トークンの取り消し

  1. https://appcenter.ms に移動します。
  2. App Center ポータルの右上隅で、アカウントのアバターをクリックし、[ アカウント設定] を選択します。
  3. 中央のパネルで、メニューから [ユーザー API トークン ] を選択します。
  4. 取り消すトークンの横にあるチェック ボックスをオンにし、右上隅にある [ 削除 ] ボタンをクリックします。

アプリ API トークンの取り消し

  1. https://appcenter.ms に移動します。
  2. API トークンを取り消すアプリを選択します。
  3. 左側で、[ 設定] を選択します。
  4. 中央のパネルで、メニューから [アプリ API トークン ] を選択します。
  5. 取り消すトークンの横にあるチェック ボックスをオンにし、右上隅にある [ 削除 ] ボタンをクリックします。