このページでは、Apps APIを利用するために必要なアクセストークンの取得方法と認証手順を解説します。
アプリID、アプリシークレット、アクセストークンは認証情報です。外部の変換サイト、チャット、GitHub、問い合わせ本文などに貼り付けないでください。
APIを使うための準備
Appsの管理画面(API設定画面)で、以下の情報を確認します。
- アプリID
- アプリシークレット
Apps APIの接続先は本番環境です。現在、Sandbox環境は提供していません。
アクセストークンの取得方法
アクセストークンを取得するには、APP_ID:APP_SECRET をBase64エンコードした値をBasic認証ヘッダーに指定します。
Mac / Linux
echo -n "APP_ID:APP_SECRET" | base64
Windows PowerShell
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("APP_ID:APP_SECRET"))
生成した文字列を使って、以下のようにアクセストークンを取得します。
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"
成功したときのレスポンス例
{
"access_token": "取得したアクセストークンがここに入ります",
"expires_in": 3600,
"token_type": "Bearer"
}
access_tokenは後続のAPI呼び出しで利用します。expires_inはトークンの有効期限(秒)です。この例では3600秒です。- 期限切れ後は、新しいアクセストークンを取得してください。
APIを利用する
取得したアクセストークンをHTTPリクエストヘッダーに指定します。
Authorization: Bearer {access_token}
顧客情報を取得する場合の例です。
curl -H "Authorization: Bearer {access_token}" \
https://api.theapps.jp/v1/customer/{customer_id}
本番環境
現在、Apps APIのSandbox環境は提供していません。APIの接続先は本番環境 https://api.theapps.jp です。
検証時は、実データ・実決済・実顧客情報に影響しない範囲で、対象データ、権限、実行内容を確認してからリクエストしてください。
よくあるご質問
- アクセストークンの有効期限が切れたら?
- 再度アクセストークン取得リクエストを実行し、新しいトークンを取得してください。
- トークンは毎回取得する必要がありますか?
- 毎回ではありません。有効期限内であれば再利用できます。
- アクセストークンやアプリシークレットはどこに保存すればよいですか?
- 公開リポジトリ、チャット、問い合わせ本文、外部変換サイトには保存しないでください。実装環境の安全なシークレット管理機能や、権限管理された環境変数などで管理してください。