このページでは、Apps APIを利用するために必要なアクセストークンの取得方法と認証の手順を解説します。
APIを使うための準備
まず、以下の情報を管理画面で確認します。
- アプリID
- アプリシークレット
Appsの管理画面(API設定画面)にログインして取得してください。
アクセストークンの取得方法
アクセストークンを取得するには、以下のコマンド(curl)を実行します。
curl -H "Content-Type: application/x-www-form-urlencoded" \
-H "Authorization: Basic {Base64エンコードしたAPP_ID:APP_SECRET}" \
-X POST "https://api.theapps.jp/v1/identity/oauth2/token" \
-d "grant_type=client_credentials"
{Base64エンコードしたAPP_ID:APP_SECRET} には、
アプリID:アプリシークレット を Base64でエンコードした文字列を入れてください。
成功すると下記のような JSON が返ります。
{
"access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"expires_in": 3600,
"token_type": "Bearer"
}
取得した access_token を保存し、後続の API 呼び出しで
Authorization: Bearer {access_token} ヘッダーとして利用します。
【補足】Base64エンコード方法
「アプリID:アプリシークレット」をBase64エンコードする必要があります。
以下のサイトなどで簡単に生成できます。
【補足】ターミナルで Base64 を生成する例
Mac / Linux
echo -n "APP_ID:APP_SECRET" | base64
Windows PowerShell
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("APP_ID:APP_SECRET"))
成功したときのレスポンス例
実行すると、以下のようなJSONレスポンスが返ってきます。
{
"access_token": "取得したアクセストークンがここに入ります",
"expires_in": 3600,
"token_type": "Bearer"
}
access_tokenをコピーして保存します。expires_inはトークンの有効期限(秒単位)を示します。この例では3600秒(=1時間)で期限切れとなります。
APIを利用する
取得したアクセストークンを使い、Apps APIにアクセスできます。
以下は顧客情報を取得する例です(顧客情報取得API)。
curl -H "Authorization: Bearer {取得したアクセストークン}" \
https://api.theapps.jp/v1/customer/{customer_id}
テスト環境(Sandbox)と本番環境
| 環境 | ベース URL |
|---|---|
| テスト | https://sandbox-api.theapps.jp |
| 本番 | https://api.theapps.jp |
- 管理画面でテスト用アプリID / シークレットを取得
- sandbox-api に切り替えて mode=test で動作確認
- 問題なければ本番 ID / シークレット+mode=live で運用
テスト用トークンは本番APIでは利用できません。
よくあるご質問
- アクセストークンの有効期限が切れたら?
- 再度アクセストークン取得コマンドを実行して、新しいトークンを取得してください。
- トークンは毎回取得する必要がある?
- 毎回ではなく、有効期限内(通常1時間)であれば再利用可能です。
- アクセストークンの安全な管理方法は?
- アクセストークンは秘密情報なので、外部に漏れないように安全に管理してください。
Apps APIメニュー
| メニュー | 説明 |
|---|---|
| API設定方法 | アクセストークンの取得やAPI認証方法 |
| APIエンドポイント一覧 | 顧客情報・決済情報取得のためのAPI仕様 |
| APIレスポンスデータ構造 | APIから取得できるデータの詳細 |
| Webhookの設定方法 | イベント通知を受け取るためのWebhook設定方法 |
| Webhookデータ構造 | Webhookで通知されるデータ形式 |
| サンプルJSONデータ | API/Webhookで利用可能なサンプルデータ |
| API変更履歴 / リリースノート | Apps APIの更新、新機能、仕様変更を時系列で確認できます。 |
| サポートコミュニティ | 準備中 |
| よくあるご質問 | 準備中 |