"[レガシー] アドオンパートナーのアプリ情報 API"

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2020年07月13日(月)

この API は非推奨になる予定であり、代わりに新しいバージョンが推奨されています。現在の API については、アドオンパートナー API​ を確認してください。

これは、アドオンのインストールに関する情報に対してクエリを実行するために使用できる API 呼び出しのための参照ドキュメントです。これらの例では、ユーザーがリクエストを発行し、Heroku が応答を提供します。すべての呼び出しで、アドオン ID (heroku-redis など) と、アドオンマニフェストで指定されているユーザー名とパスワードで HTTP 基本認証を使用する必要があります。

アプリ情報 API エンドポイントで返される callback_url​ および heroku_id​ 属性は、互換性のみを目的としています。パートナーには、これらを使用しないことをお勧めします。代わりに、アプリ情報の取得​エンドポイントと provider_id​ 属性を使用してください。

すべてのアプリの取得

アドオンをインストールしているアプリの一覧を取得します。resource.uuid​ 値は、プロビジョニングリクエスト中に送信される uuid​ フィールドに対応しています。

GET https://<username>:<password>@api.heroku.com/vendor/apps

応答の例

[
  {
    "callback_url": "https://api.heroku.com/vendor/apps/01234567-89ab-cdef-0123-456789abcdef",
    "heroku_id": "app123@heroku.com",
    "plan": "test",
    "provider_id": "1",
    "resource": {
      "uuid": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "addon-fluffy-6756"
    }
  },
  {
    "callback_url": "https://api.heroku.com/vendor/apps/abcdef12-3456-7890-abcd-ef1234567890",
    "heroku_id": "app456@heroku.com",
    "plan": "premium",
    "provider_id": "3",
    "resource": {
      "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
      "name": "addon-vertical-9873"
    }
  }
]

結果のページ分割

4000 より大きい結果はページ分割されます。ページ分割の情報は、Link​ HTTP ヘッダー経由で渡されます。ページ分割をクライアントコードで構成するのではなく、これらの URI を使用して移動します。

例

Link: <https://api.heroku.com/vendor/apps?offset=100>; rel="prev", <https://api.heroku.com/vendor/apps?offset=1000>; rel="next"

そのヘッダー内の指定できる rel​ 値は次のとおりです。

  • next​: 結果の直後のページの URL を示します。
  • prev​: 結果の直前のページの URL を示します。

アプリ情報の取得

いずれかのアドオンインスタンスに関する詳細 (アプリの名前、プラン、所有者のメールを含む) を取得します。これは、顧客との通信のためのアプリ名を見つけるために使用されるエンドポイントです (heroku_id は顧客によって認識されないため、使用しないこと)​。

このエンドポイントは、プロビジョニング​が完了すると 200 応答のみを返します。プロビジョニングリクエスト中にアプリ情報にアクセスしようとすると、404 応答が返されます。一部のフィールドはアドオンマニフェストに依存しており、省略される可能性があります。

GET https://<username>:<password>@api.heroku.com/vendor/apps/:provider_id

ここで、使用される識別子は次のいずれかです (設定の降順に示す)。

  • provider_id
  • resource.uuid
  • heroku_id​ - 注意、共有可能なアドオンの機能との将来の互換性のために、この識別子の使用を停止することをお勧めします。

応答の例

{
  "id": "app123@heroku.com",
  "callback_url": "https://api.heroku.com/vendor/apps/01234567-89ab-cdef-0123-456789abcdef",
  "config": {
    "MYADDON_URL": "http://myaddon.com/52e82f5d73"
  },
  "domains": [ "www.the-consumer.com", "the-consumer.com" ],
  "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
  "name": "myapp",
  "plan": "test",
  "owner_email": "glenn@heroku.com",
  "owner": {
    "uuid":  "31e71f4d-b0f6-4250-8c1a-f914b99adba2",
    "email": "glenn@heroku.com"
  },
  "region": "amazon-web-services::us-east-1",
  "resource": {
    "uuid": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "addon-fluffy-6756"
  }
}

環境設定の更新

プロビジョニング中にアプリケーションに対して以前に設定された環境設定を更新します。

アドオンマニフェスト​で宣言されている環境設定のみを更新できます。

本体には、更新する設定のハッシュが含まれている必要があります。

PUT https://{username}:{password}@api.heroku.com/vendor/apps/{provider_id}

curl の例

$ curl -n -X PUT https://$USERNAME:$PASSWORD@api.heroku.com/vendor/apps/$PROVIDER_ID \
-H "Content-Type: application/json" \
-d '{
  "config": {
    "MYADDON_URL": "http://myaddon.com/ABC123"
  }
}'

エラー応答

エラーの根本的原因に応じて、次の応答コードが返されます。

401​: 無効なユーザー名とパスワードの組み合わせが指定され、まだ正常に認証されていません。

404​: 要求されたアプリが存在しない (たとえば、削除されている) か、またはアドオンがこのアプリに対してプロビジョニング解除されています。