Add on app info

これは、アドオンのインストール状況についての情報を問い合わせたくなったときに使用できるAPIコールについてのリファレンスドキュメントです。これらの例の中で、リクエストを実際に投げて、Herokuにレスポンスを返してもらいます。すべてのAPIコールは、アドオンマニフェスト内に記してある、アドオンのIDとパスワードを使ったHTTPベーシック認証を使用するべきです。

全てのアプリケーションの取得

Request       : GET https://username:password@api.heroku.com/vendor/apps
Response Body : 
  [
    { "provider_id": "1",
      "heroku_id": "app123@heroku.com",
      "callback_url": "https://api.heroku.com/vendor/apps/app123%40heroku.com",
      "plan": "test" },
    { "provider_id": "3",
      "heroku_id": "app456@heroku.com",
      "callback_url": "https://api.heroku.com/vendor/apps/app456%40heroku.com",
      "plan": "premium" }
  ]

この呼び出しで、あなたのアドオンがインストールされているアプリケーションのリストを取得する事が出来ます。

結果のページング

4000件以上の結果は、ページングが発生します。ページネーションの情報はLinkHTTPヘッダを 経由して送られてきます。クライアントのコードでこれらを組み立てるよりも、 URIを使って、ページングを切り替えるようにしましょう。

Example:

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を表示しています。

アプリケーションの情報の取得

Request       : GET https://username:password@api.heroku.com/vendor/apps/:heroku_id
Response Body : 
  { "id": "app123@heroku.com",
    "name": "myapp",
    "config": {"MYADDON_URL": "http://myaddon.com/52e82f5d73"},
    "callback_url": "https://api.heroku.com/vendor/apps/app123%40heroku.com",
    "owner_email": "glenn@heroku.com",
    "region": "amazon-web-services::us-east-1",
    "domains": ["www.the-consumer.com", "the-consumer.com"]
  }

この呼び出しを使うと、あなたのアドオンが使われているインスタンスの詳細の全てのまとまりを確認する事が出来ます。

設定変数の更新

Request        : PUT https://username:password@api.heroku.com/vendor/apps/:heroku_id
Request Body   : { "config": {"MYADDON_URL": "http://myaddon.com/ABC123"}}
Response       : 200 OK

アドオンが配備されている間に、アプリケーション向けに適応している設定変数を更新するために、この呼び出しを使ってください。

addon-manifest.json内で宣言した設定変数のみ更新する事が可能です。