Skip Navigation
Show nav
Heroku Dev Center
  • Get Started
  • ドキュメント
  • Changelog
  • Search
  • Get Started
    • Node.js
    • Ruby on Rails
    • Ruby
    • Python
    • Java
    • PHP
    • Go
    • Scala
    • Clojure
  • ドキュメント
  • Changelog
  • More
    Additional Resources
    • Home
    • Elements
    • Products
    • Pricing
    • Careers
    • Help
    • Status
    • Events
    • Podcasts
    • Compliance Center
    Heroku Blog

    Heroku Blog

    Find out what's new with Heroku on our blog.

    Visit Blog
  • Log inorSign up
View categories

Categories

  • Heroku のアーキテクチャ
    • Dyno (アプリコンテナ)
    • スタック (オペレーティングシステムイメージ)
    • ネットワーキングと DNS
    • プラットフォームポリシー
    • プラットフォームの原則
  • コマンドライン
  • デプロイ
    • Git を使用したデプロイ
    • Docker によるデプロイ
    • デプロイ統合
  • 継続的デリバリー
    • 継続的統合
  • 言語サポート
    • Node.js
    • Ruby
      • Bundler の使用
      • Rails のサポート
    • Python
      • Python でのバックグランドジョブ
      • Django の使用
    • Java
      • Maven の使用
      • Java でのデータベース操作
      • Spring Boot の使用
      • Java の高度なトピック
    • PHP
    • Go
      • Go の依存関係管理
    • Scala
    • Clojure
  • データベースとデータ管理
    • Heroku Postgres
      • Postgres の基礎
      • Postgres Getting Started
      • Postgres のパフォーマンス
      • Postgres のデータ転送と保持
      • Postgres の可用性
      • Postgres の特別なトピック
    • Heroku Redis
    • Apache Kafka on Heroku
    • その他のデータストア
  • モニタリングとメトリクス
    • ログ記録
  • アプリのパフォーマンス
  • アドオン
    • すべてのアドオン
  • 共同作業
  • セキュリティ
    • アプリのセキュリティ
    • ID と認証
    • コンプライアンス
  • Heroku Enterprise
    • Private Space
      • インフラストラクチャネットワーキング
    • Enterprise Accounts
    • Enterprise Team
    • Heroku Connect (Salesforce 同期)
      • Heroku Connect の管理
      • Heroku Connect のリファレンス
      • Heroku Connect のトラブルシューティング
    • シングルサインオン (SSO)
  • パターンとベストプラクティス
  • Heroku の拡張
    • Platform API
    • アプリの Webhook
    • Heroku Labs
    • アドオンのビルド
      • アドオン開発のタスク
      • アドオン API
      • アドオンのガイドラインと要件
    • CLI プラグインのビルド
    • 開発ビルドパック
    • Dev Center
  • アカウントと請求
  • トラブルシューティングとサポート
  • Integrating with Salesforce
  • Heroku の拡張
  • アドオンのビルド
  • アドオン API
  • "[レガシー] アドオンパートナーのアプリ情報 API"

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

日本語 — Switch to English

最終更新日 2022年10月03日(月)

Table of Contents

  • すべてのアプリの取得
  • アプリ情報の取得
  • 環境設定の更新
  • ログドレインの情報
  • ログドレインの更新
  • アドオンベータユーザーのカウント

従来のアドオンアプリ情報 API は非推奨であり、2023 年 7 月 3 日のサポート終了 (EOL) が予定されています。サポート終了についての詳細は、FAQ の記事​を参照してください。

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

すべてのアプリの取得

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

GET https://<manifest_id>:<manifest_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"
    }
  }
]

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

結果のページ分割

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://<manifest_id>:<manifest_password>@api.heroku.com/vendor/apps/<app_identifier>

ここで、使用される app_identifier​ は次のいずれかである必要があります (設定の降順に示す)。

  • 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"
  }
}

環境設定の更新

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

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

本文は、1 つの config キーのみがキーと値のペアのオブジェクトに設定されている、1 つのオブジェクトで構成される JSON 文字列である必要があります。各ペアには、割り当てる必要があるキーと新しい値としての環境設定名が必要です。

PUT https://<manifest_id>:<manifest_password>@api.heroku.com/vendor/apps/<provider_id>

curl の例

$ curl -n -X PUT https://$MANIFEST_ID:$MANIFEST_PASSWORD@api.heroku.com/vendor/apps/$PROVIDER_ID \
-H "Content-Type: application/json" \
-d '{
  "config": {
    "MYADDON_URL": "https://myaddon.com/ABC123",
    "MYADDON_API_KEY": "0123456789abcdef"
  }
}'

ログドレインの情報

プロビジョニング中にアプリケーションに対して設定された既存のログドレイン URL の詳細を取得します。

ログドレインエンドポイントはデフォルトでブロックされており、個別のアドオンパートナーに手動で開放する必要があります。リクエストが 401 - Unauthorized​ HTTP エラーコードで拒否された場合は、新しいサポートチケットを開いて​、このエンドポイントの利用に関心があることをお知らせください。

GET https://<manifest_id>:<manifest_password>@api.heroku.com/vendor/log-drains/<log_drain_token>

log_drain_token​ は、元のプロビジョニングリクエストで送信されたトークン​です。

応答の例

{
  "url": "https://example.com/drain"
}

ログドレインの更新

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

ログドレインエンドポイントはデフォルトでブロックされており、個別のアドオンパートナーに手動で開放する必要があります。リクエストが 401 - Unauthorized​ HTTP エラーコードで拒否される場合は、新しいサポートチケットを開いて​、このエンドポイントの利用に関心があることをお知らせください。

本文は、1 つの url​ キーのみが更新後のログドレイン URL に設定されている、1 つのオブジェクトで構成された JSON 文字列である必要があります。

PUT https://<manifest_id>:<manifest_password>@api.heroku.com/vendor/log-drains/<log_drain_token>

curl の例

$ curl -n -X PUT https://$MANIFEST_ID:$MANIFEST_PASSWORD@api.heroku.com/vendor/log-drains/$LOG_DRAIN_TOKEN \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com/new-drain"
}‘

エラー応答

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

401​: 無効なユーザー名とパスワードの組み合わせが指定され、まだ正常に認証されていません。このエラーは、いずれかのログドレインエンドポイントを使おうとしたが、アドオンで当該エンドポイントへのアクセスを手動で有効化していない場合にも返されます。

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

アドオンベータユーザーのカウント

アドオンが一般提供段階に進む前に、アドオンプロバイダにはアドオンをテストする最低 100 個の固有ベータユーザーが必要です。

ベータユーザーのカウントを取得するには、以下の手順に従います。

  1. アプリ情報の取得​エンドポイントを使用して、アドオンが現在インストールされているすべてのアプリを取得し、provider_id​ のリストを作成します。
  2. アプリ情報の取得​エンドポイントを、provider_id​ ごとに 1 回使用して、アプリ所有者メールのリスト (属性 owner.email​) を作成します。
  3. 重複するアプリ所有者メールを削除し、一意のカウントを取得します。

実装例

これは、curl​ および標準の *nix ツールを使用した Bash スクリプトの例です。

#!/bin/bash

MANIFEST_ID="<manifest_id>"
MANIFEST_PASSWORD="<manifest_password>"

function app_list {
  curl -s -X GET https://${MANIFEST_ID}:${MANIFEST_PASSWORD}@api.heroku.com/vendor/apps
}

function extract_app_provider_id {
  sed -n '/provider_id/! { d; }; /.*"provider_id":"\(.*\)"/ { s//\1/; p; }'
}

function app_info() {
  curl -s -X GET https://${MANIFEST_ID}:${MANIFEST_PASSWORD}@api.heroku.com/vendor/apps/$1
}

function extract_owner_email {
  sed -n '/owner_email/! { d; }; /.*\"owner_email\":"\(.*\)".*/ { s//\1/; p; }'
}

echo "Unique app owners for '${MANIFEST_ID}': $(for i in $(app_list | extract_app_provider_id); do app_info $i | extract_owner_email; done | sort -u | wc -l)"

関連カテゴリー

  • アドオン API
アドオンパートナーのイベント通知 アドオンパートナーのイベント通知

Information & Support

  • Getting Started
  • Documentation
  • Changelog
  • Compliance Center
  • Training & Education
  • Blog
  • Podcasts
  • Support Channels
  • Status

Language Reference

  • Node.js
  • Ruby
  • Java
  • PHP
  • Python
  • Go
  • Scala
  • Clojure

Other Resources

  • Careers
  • Elements
  • Products
  • Pricing

Subscribe to our monthly newsletter

Your email address:

  • RSS
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku Blog
    • Heroku News Blog
    • Heroku Engineering Blog
  • Heroku Podcasts
  • Twitter
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku
    • Heroku Status
  • Facebook
  • Instagram
  • Github
  • LinkedIn
  • YouTube
Heroku is acompany

 © Salesforce.com

  • heroku.com
  • Terms of Service
  • Privacy
  • Cookies
  • Cookie Preferences