カラーミーショップアプリストア API
カラーミーショップアプリストア API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
カラーミーショップアプリストア API
アプリストアにて公開するアプリに対して、一般公開しているカラーミーショップAPIに加えて、カラーミーショップアプリストアAPI(以下、アプリストアAPIといいます)を利用することが出来ます。アプリストアAPIでは以下のことが行えます。
- 課金データ(アプリ内課金、従量課金)の作成
- インラインスクリプトタグの取得・作成・更新・削除
- スクリプトタグの取得・作成・更新・削除
利用手順
アプリストアAPIを利用するには、OAuth認証が必要です。OAuth認証の基本的な流れについてはカラーミーショップAPIドキュメントを参照してください。
アプリストアAPIの利用のために、以下のscopeが追加で指定可能になります。カラーミーショップAPIドキュメントに掲載されているscopeと合わせてご利用ください。
| スコープ | 機能 |
|---|---|
write_application_charge | 課金データの作成 |
read_shop_script_tags | ショップページのスクリプトタグを参照 |
write_shop_script_tags | ショップページへスクリプトタグを追加・更新 |
read_inline_script_tags | インラインスクリプトタグを参照 |
write_inline_script_tags | インラインスクリプトタグを追加・更新 |
read_script_tags | スクリプトタグを参照(deprecated) |
write_script_tags | スクリプトタグを追加・更新(deprecated) |
(例) カラーミーショップアカウントの認証ページを表示
https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&scope=read_products%20write_products%20write_application_charge課金設定
料金プラン(月額課金・従量課金・買い切り)による課金や、アプリ内課金をご利用いただくにはアプリごとに課金設定の登録が必要です。
この設定は カラーミーショップ デベロッパー から行うことができます。
登録できる課金形式やその使い方の詳細についてはアプリストア 開発ガイドのアプリ課金のページをご覧ください
アプリのインストール
ショップオーナーがアプリをインストールしたとき、以下の処理をカラーミーショップが行います。
- 選択された料金プランに基づき課金開始
- インストールフックの呼び出し
インストールフック
アプリのインストール時に、インストールに関する情報を POST メソッド、 application/json 形式で通知します。
通知先のURLはカラーミーショップ デベロッパーにログインし、各アプリストア アプリのアプリ設定から登録を行ってください。
以下のパラメータが送信されます。課金請求に必要なパラメータを含みますので、必ず受け取れるようにしてください。
| パラメータ | 機能 | 形式 |
|---|---|---|
account_id | インストールしたショップオーナーのアカウントID | PA+8桁の整数 |
application_charge_source_id | プラン課金ID | 数字と大文字アルファベットで構成される文字列(6桁以上) |
recurring_application_charge_id | (買い切り以外の課金の場合)課金契約ID | 数字と大文字アルファベットで構成される文字列(6桁以上) |
application_charge_id | (買い切りの場合)課金契約ID | 数字と大文字アルファベットで構成される文字列(6桁以上) |
trial_term | (無料お試し期間がある場合)無料お試し期間 | JSONオブジェクト |
mail | ショップオーナーへの連絡メールアドレス | 文字列 |
application_charge_source_id はデベロッパーサイトで設定したプラン課金のIDです。インストールされた料金プランの判別にご利用いただけます。
recurring_application_charge_id と application_charge_id はインストールごとに発行されるユニークなIDです。ショップオーナーが一度アンインストールした後に、再度同じショップオーナーがアプリのインストールを行った際には新たに別のIDが発行されます。
recurring_application_charge_id は「買い切り」以外の課金である「無料」「月額」「月額+従量」「月額+初期費用」「従量のみ」のプラン課金のインストールの際に発行されます。
従量による課金を伴うプラン課金の場合は、従量分の料金を請求する際に 課金契約ID(recurring_application_charge_id) が必要になるので、必ず記録するようにしてください。
mail パラメータの値はショップオーナーへの連絡手段としてご利用いただけます。インストール後に認可フローが中断され、アクセストークンが得られない際のショップオーナーへの連絡手段としてご活用いただけます。このパラメータはカラーミーショップの非公開情報として登録されている値です。左記以外の用途でこの値をアプリの機能で使用しないでください。
例) 買い切りの場合
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"application_charge_id": "A3FT4N",
"mail": "shop@example.com"
}例) 月額課金の場合
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"recurring_application_charge_id": "A3FT4N",
"mail": "shop@example.com"
}無料お試し期間を設定した課金の場合、以下の情報を trial_term パラメータとして送信します。
無料お試し期間中は従量課金APIを呼び出して課金請求することはできません。
| パラメータ | 機能 | 形式 |
|---|---|---|
starts_at | 無料お試し開始日時 | 整数値(UNIXタイムスタンプ) |
ends_at | 無料お試し終了日時 | 整数値(UNIXタイムスタンプ) |
例) 無料お試し期間がある月額課金の場合
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"recurring_application_charge_id": "A3FT4N",
"mail": "shop@example.com",
"trial_term" {
"starts_at": 1565017200,
"ends_at": 1567609200
}
}受け取りに成功した場合は、以下のパラメータを application/json 形式でレスポンスボディに付与し、
ステータスコード 200 レスポンスをカラーミーショップへ返却してください。
ステータスコード 200 レスポンスをカラーミーショップが受け取れない場合、もしくは以下のパラメーターが返却されなかった場合、インストールを中止し、インストールによって発生した情報は破棄されます。
| パラメータ | 機能 | 形式 |
|---|---|---|
redirect_url | インストール成功後に遷移するURL | 文字列(URL) |
例)
{
"redirect_url": "https://example.com"
}インストール完了後、インストールフックのレスポンスパラメータの redirect_url へ画面遷移しますので、APIを利用する場合は redirect_url より先の画面でOAuth認証の実装をお願いします。
アプリのアンインストール
ショップオーナーがアプリをアンインストールしたとき、以下の処理をカラーミーショップが行います。
- OAuth認証のアクセストークンの無効化
- 登録したインラインスクリプトタグ・スクリプトタグの削除
- 月額課金形式の場合、継続課金の無効化
アンインストールフック
アンインストール直後に POST メソッドで、以下の情報を application/json 形式で通知します。
通知先のURLはカラーミーショップ デベロッパーにログインし、各アプリストア アプリのアプリ設定から登録を行ってください。
※ アンインストールAPIのご利用によるアンインストール時はアンインストールフックは通知されません。
受け取りに成功した場合はステータスコード 200 のレスポンスを返却してください。
| パラメータ | 機能 | 形式 |
|---|---|---|
account_id | アンインストールしたショップオーナーのアカウントID | PA+8桁の整数 |
application_charge_source_id | プラン課金ID | 数字と大文字アルファベットで構成される文字列(6桁以上) |
uninstalled_at | アンインストール日時 | 整数値(UNIXタイムスタンプ) |
reason | アンインストール理由 | by_shop_owner (ショップオーナーによる) by_unpaid (未払いによる) |
recurring_application_charge_id | (買い切り以外の課金の場合)課金契約ID | 数字と大文字アルファベットで構成される文字列(6桁以上) |
usage_charge | (従量課金の場合)従量課金アンインストール情報 | JSONオブジェクト |
アンインストールフックの通知が伴うアンインストールは以下の操作のいずれかによって行われます。アンインストールの理由を reason…
Endpoints 18
application_charge
- POSTアプリ内課金データの作成
/appstore/v1/application_charges.json「アプリ内課金」はすでにインストール済みのアプリ上において、利用者が追加の買い切りによる課金によって新たなアプリ内の機能を提供される場合などに、利用者へ買い切りの課金分の請求を行うための課金形式です。… - POST従量課金データの作成
/appstore/v1/recurring_application_charges/:recurringApplicationChargeId/usage_charges.jsonアプリ内で基本機能が利用された頻度に伴って毎月の請求が変動するようなアプリの場合は「従量課金」を使って利用者に変動分の請求を行うことができます。 ※無料お試し期間中のショップに対しては従量課金データを作成できません。
script
- GETスクリプトタグの取得
/appstore/v1/script_tags.json - POSTスクリプトタグの作成
/appstore/v1/script_tags.json - GETスクリプトタグの取得
/appstore/v1/script_tags/:scriptTagId.json - PUTスクリプトタグの更新
/appstore/v1/script_tags/:scriptTagId.json - DELETEスクリプトタグの削除
/appstore/v1/script_tags/:scriptTagId.json
script(deprecated)
- GETスクリプトタグの取得
/v1/script_tags.json - POSTスクリプトタグの作成
/v1/script_tags.json - GETスクリプトタグの取得
/v1/script_tags/:scriptTagId.json - PUTスクリプトタグの更新
/v1/script_tags/:scriptTagId.json - DELETEスクリプトタグの削除
/v1/script_tags/:scriptTagId.json
inline_script
- GETインラインスクリプトタグの取得
/v1/inline_script_tags.json - POSTインラインスクリプトタグの登録
/v1/inline_script_tags.json - GETインラインスクリプトタグの取得
/v1/inline_script_tags/:inlineScriptTagId.json - PUTインラインスクリプトタグの更新
/v1/inline_script_tags/:inlineScriptTagId.json - DELETEインラインスクリプトタグの削除
/v1/inline_script_tags/:inlineScriptTagId.json
uninstallation
- DELETEアプリストアアプリのアンインストール
/appstore/v1/installation.jsonこのAPIは OAuth のアクセストークンに紐付くアプリケーションをショップから削除します。 このAPIを利用した場合、ショップオーナーがアンインストールした場合と異なり、アンインストールフックは実行されません。 代わりにアンインストールフックで通知される情報は、このAPIのレスポンスに含まれています。…
API details
- Base URL
https://api.shop-pro.jp- Authentication
- OAuth 2.0 (authorization code flow) with 7 scopes
- Operations
- 18 operations on 9 pathsGET 6POST 5DELETE 4PUT 3
- Main resources
- inline_script 5script 5script(deprecated) 5application_charge 2uninstallation 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the カラーミーショップアプリストア API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the カラーミーショップアプリストア API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 7 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “アプリ内課金データの作成” (POST /appstore/v1/application_charges.json), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the カラーミーショップアプリストア API?
カラーミーショップアプリストア API… It is listed under E-commerce and has 18 endpoints.
Who publishes the カラーミーショップアプリストア API?
It is listed from Shop Pro's public API description (an OpenAPI document), not published by Shop Pro on Swastik Codes. Anyone who controls shop-pro.jp can claim the profile by adding a DNS TXT record.
What is the base URL of the カラーミーショップアプリストア API?
Requests go to https://api.shop-pro.jp. Endpoint paths are added to this base URL.
How do I authenticate with the カラーミーショップアプリストア API?
With OAuth 2.0 (authorization code flow) with 7 scopes.
How many endpoints does the カラーミーショップアプリストア API have?
18 operations on 9 paths (6 GET, 5 POST, 4 DELETE, 3 PUT). The largest groups are inline_script, script, script(deprecated), application_charge.
Is forking the カラーミーショップアプリストア API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.