Apps APIで提供している各種APIのエンドポイントについてまとめています。
それぞれのエンドポイントにアクセスするには事前にアクセストークンを取得しておく必要があります。
顧客情報を取得する
顧客の基本情報を取得するAPIです。
GET https://api.theapps.jp/v1/customer/{customer_id}
{customer_id} はWebhookなどで通知された顧客IDを指定してください。
決済情報を取得する(1回払い)
1回払いプランの決済情報を取得するAPIです。
GET https://api.theapps.jp/v1/charge/{payment_id}
{payment_id} はWebhookなどで通知された決済IDを指定してください。
決済情報を取得する(定期払い)
定期払いプランの決済情報を取得するAPIです。
GET https://api.theapps.jp/v1/paid/{payment_id}
{payment_id} はWebhookなどで通知された決済IDを指定してください。
決済情報を取得する(毎月払い(回数制限付き))
毎月払い(回数制限付き)プランの決済情報を取得するAPIです。
GET https://api.theapps.jp/v1/installments/{payment_id}
{payment_id} はWebhookなどで通知された決済IDを指定してください。
各APIの呼び出し方法
取得したアクセストークンを使い、HTTPリクエストヘッダーに下記のように指定して呼び出します。
Authorization: Bearer {取得したアクセストークン}
テスト環境の利用
テスト環境(Sandbox)で動作確認をする場合は、各エンドポイントのURLを下記のベースURLに変更してください。
https://sandbox-api.theapps.jp/v1/...
備考・注意事項
- APIの詳細なレスポンス形式については APIレスポンスデータ構造 をご覧ください。
- 各種イベント通知の受信方法については Webhookの設定方法 をご覧ください。
Apps APIメニュー
| メニュー | 説明 |
|---|---|
| API設定方法 | アクセストークンの取得やAPI認証方法 |
| APIエンドポイント一覧 | 顧客情報・決済情報取得のためのAPI仕様 |
| APIレスポンスデータ構造 | APIから取得できるデータの詳細 |
| Webhookの設定方法 | イベント通知を受け取るためのWebhook設定方法 |
| Webhookデータ構造 | Webhookで通知されるデータ形式 |
| サンプルJSONデータ | API/Webhookで利用可能なサンプルデータ |
| API変更履歴 / リリースノート | Apps APIの更新、新機能、仕様変更を時系列で確認できます。 |
| サポートコミュニティ | 準備中 |
| よくあるご質問 | 準備中 |