Skip Navigation
Show nav
Dev Center
  • Get Started
  • ドキュメント
  • Changelog
  • Search
  • Get Started
    • Node.js
    • Ruby on Rails
    • Ruby
    • Python
    • Java
    • PHP
    • Go
    • Scala
    • Clojure
    • .NET
  • ドキュメント
  • 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 (アプリコンテナ)
      • Dyno Management
      • Dyno Concepts
      • Dyno Behavior
      • Dyno Reference
      • Dyno Troubleshooting
    • スタック (オペレーティングシステムイメージ)
    • ネットワーキングと DNS
    • プラットフォームポリシー
    • プラットフォームの原則
  • Developer Tools
    • コマンドライン
    • Heroku VS Code Extension
  • デプロイ
    • Git を使用したデプロイ
    • Docker によるデプロイ
    • デプロイ統合
  • 継続的デリバリーとインテグレーション
    • 継続的統合
  • 言語サポート
    • Node.js
      • Working with Node.js
      • Node.js Behavior in Heroku
      • Troubleshooting Node.js Apps
    • Ruby
      • Rails のサポート
      • Bundler の使用
      • Working with Ruby
      • Ruby Behavior in Heroku
      • Troubleshooting Ruby Apps
    • Python
      • Working with Python
      • Python でのバックグランドジョブ
      • Python Behavior in Heroku
      • Django の使用
    • Java
      • Java Behavior in Heroku
      • Working with Java
      • Maven の使用
      • Spring Boot の使用
      • Troubleshooting Java Apps
    • PHP
      • PHP Behavior in Heroku
      • Working with PHP
    • Go
      • Go の依存関係管理
    • Scala
    • Clojure
    • .NET
      • Working with .NET
  • データベースとデータ管理
    • Heroku Postgres
      • Postgres の基礎
      • Postgres スターターガイド
      • Postgres のパフォーマンス
      • Postgres のデータ転送と保持
      • Postgres の可用性
      • Postgres の特別なトピック
      • Migrating to Heroku Postgres
    • Heroku Data For Redis
    • Apache Kafka on Heroku
    • その他のデータストア
  • AI
    • Working with AI
    • Heroku Inference
      • Inference API
      • Quick Start Guides
      • AI Models
      • Inference Essentials
    • Vector Database
    • Model Context Protocol
  • モニタリングとメトリクス
    • ログ記録
  • アプリのパフォーマンス
  • アドオン
    • すべてのアドオン
  • 共同作業
  • セキュリティ
    • アプリのセキュリティ
    • ID と認証
      • シングルサインオン (SSO)
    • Private Space
      • インフラストラクチャネットワーキング
    • コンプライアンス
  • Heroku Enterprise
    • Enterprise Accounts
    • Enterprise Team
    • Heroku Connect (Salesforce 同期)
      • Heroku Connect の管理
      • Heroku Connect のリファレンス
      • Heroku Connect のトラブルシューティング
  • パターンとベストプラクティス
  • Heroku の拡張
    • Platform API
    • アプリの Webhook
    • Heroku Labs
    • アドオンのビルド
      • アドオン開発のタスク
      • アドオン API
      • アドオンのガイドラインと要件
    • CLI プラグインのビルド
    • 開発ビルドパック
    • Dev Center
  • アカウントと請求
  • トラブルシューティングとサポート
  • Salesforce とのインテグレーション
  • Heroku の拡張
  • Platform API
  • Platform API スターターガイド

Platform API スターターガイド

日本語 — Switch to English

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

最終更新日 2023年06月14日(水)

Table of Contents

  • 前提条件
  • サンプル
  • 認証
  • API の呼び出し
  • 代替
  • まとめ

これは、Heroku Platform API の使用開始を支援するための簡単なガイドです。詳細なリファレンスについては、「Platform API Reference​」 (Platform API リファレンス) の記事を参照してください。

前提条件

  1. curl​ のシェル
  2. Heroku ユーザーアカウント。無料ですぐにサインアップできます​。

サンプル

以下のサンプルでは、便宜上 curl​ を使用します。お好みのプログラミング言語と HTTP ライブラリを API で使用することをお勧めします。

または、以下のクライアントライブラリも使用できます。

  • Go: ​heroku-go
  • Node: ​node-heroku-client
  • PHP: ​php-heroku-client
  • Ruby: ​platform-api
  • Scala: ​Heroku.scala

認証

認証は、Bearer {token}​ に設定された値とともに Authorization​ ヘッダーで渡されます。

curl​ を使用していて、Heroku CLI でログインしている場合、curl -n​ を使用して自動でこのヘッダーを CLI と同じトークンに設定できます。このトークンは、heroku auth:token​ で取得することもできますが、有効期間はデフォルトで最大 1 年間です。

heroku authorizations:create​ を実行して、有効期限のないトークンを作成することができます。

$ heroku authorizations:create -d "getting started token"
Creating OAuth Authorization... done
Client:      <none>
ID:          a6e98151-f242-4592-b107-25fbac5ab410
Description: getting started token
Scope:       global
Token:       cf0e05d9-4eca-4948-a012-b91fe9704bab
Updated at:  Fri Jun 01 2018 13:26:56 GMT-0700 (PDT) (less than a minute ago)

フェデレーションユーザーへの注意

SSO を使用していて (ユーザーアカウントが ID プロバイダーに関連付けられていて)、有効期限のないトークンを作成しようとしている場合、次のエラーメッセージが表示されます。 "This account is a federated account. Federated accounts cannot issue OAuth authorizations."

API に接続する必要があり、有効期限のないトークンを使用してこれを行う必要がある場合、別のユーザーを作成し、そのユーザーを Heroku 組織に招待しますが、そのユーザーを ID プロバイダーに追加しないようにすることをお勧めします。そのユーザーは、組織によって使用されるトークンを生成して管理することができます。

API の呼び出し

netrc ファイルからのトークンを使用して、curl でアプリを作成する方法を以下に示します。

$ curl -nX POST https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3"

heroku authorizations:create​ で作成され、HEROKU_API_KEY​ 環境変数に格納されている API キーでアプリを作成するには、以下のようにします。

$ curl -X POST https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3" \
-H "Authorization: Bearer $HEROKU_API_KEY"

Windows では、以下のように定義されます。

> curl -X POST https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3" \
-H "Authorization: Bearer %HEROKU_API_KEY%"

API は、新しく作成されたアプリの詳細を含む JASON を返します。

{
  "created_at":"2013-05-21T22:36:48-00:00",
  "id":"01234567-89ab-cdef-0123-456789abcdef",
  "git_url":"git@heroku.com:cryptic-ocean-8852.git",
  "name":"cryptic-ocean-8852",
  ...
}

以下のパスで ID を渡し、作成したアプリに関する情報について API にクエリを行うこともできます。

$ curl -nX GET https://api.heroku.com/apps/01234567-89ab-cdef-0123-456789abcdef \
-H "Accept: application/vnd.heroku+json; version=3"

ユーザーが所有する、または共同作業しているすべてのアプリを一覧にすることもできます。

$ curl -nX GET https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3"

情報の取得で使用したものと同じパスに PATCH リクエストを行い、上記で作成したアプリの名前を更新します。

$ curl -nX PATCH https://api.heroku.com/apps/01234567-89ab-cdef-0123-456789abcdef \
-H "Accept: application/vnd.heroku+json; version=3" \
-H "Content-Type: application/json" \
-d "{\"name\":\"my-awesome-app\"}"

この名前を使用してアプリにクエリを行うこともできます。これは、より覚えやすい名前に変更した場合に便利です。

$ curl -n https://api.heroku.com/apps/my-awesome-app \
-H "Accept: application/vnd.heroku+json; version=3"

最後に、クリーンアップを行い、テストアプリを削除します。

$ curl -nX DELETE https://api.heroku.com/apps/01234567-89ab-cdef-0123-456789abcdef \
-H "Accept: application/vnd.heroku+json; version=3"

代替

Heroku API プラグイン​は、CLI に任意のコマンドを実行するのに使用できます。

$ heroku plugins:install api
$ heroku api POST /apps --body '{"name": "example-app"}'
POST api.heroku.com/apps... 201
{
  "name": "example-app",
  "region": {
    "id": "59accabd-516d-4f0e-83e6-6e3757701145",
    "name": "us"
  },
  "updated_at": "2018-06-01T21:00:41Z",
  "web_url": "https://example-app-1234567890ab.herokuapp.com/",
  ...
}

httpie​ は便利な cURL 代替であり、若干 cURL より使いやすくなっています。Httpie では netrc からの認証資格情報が自動的に使用され、デフォルトで JSON を POST しているものとみなされます。

$ http PATCH https://api.heroku.com/apps/example-app/config-vars \
"Accept:application/vnd.heroku+json; version=3" \
RAILS_ENV=production
HTTP/1.1 200 OK
Cache-Control: private, no-cache
Content-Encoding: gzip
Content-Length: 672
Content-Type: application/json
...
{
    "DATABASE_URL": "postgres://pg",
    "RAILS_ENV": "production"
}

まとめ

このチュートリアルでは curl​ を使用して Heroku Platform API を呼び出す方法について説明していますが、このアプローチは任意の言語および環境で使用することができます。このチュートリアルは、アプリの作成、更新、削除に重点を置いています。この API では、アドオン、環境設定、ドメインなど、さまざまなリソースを利用できます。これらはすべてアプリと同様に機能し、詳細情報は API リファレンス​で確認できます。

関連カテゴリー

  • Platform API
ゼロからの slug の作成 Platform API の JSON スキーマ

Information & Support

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

Language Reference

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

Other Resources

  • Careers
  • Elements
  • Products
  • Pricing
  • RSS
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku Blog
    • Heroku News Blog
    • Heroku Engineering Blog
  • Twitter
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku
    • Heroku Status
  • Github
  • LinkedIn
  • © 2025 Salesforce, Inc. All rights reserved. Various trademarks held by their respective owners. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States
  • heroku.com
  • Legal
  • Terms of Service
  • Privacy Information
  • Responsible Disclosure
  • Trust
  • Contact
  • Cookie Preferences
  • Your Privacy Choices