@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api カラーミーショップアプリストア API
@base https://api.shop-pro.jp
@version 1.0.0
@auth OAuth2
@endpoints 18
@toc appstore(8), inline_script_tags.json(2), inline_script_tags(3), script_tags.json(2), script_tags(3)

@group appstore
@endpoint GET /appstore/v1/script_tags.json
@desc スクリプトタグの取得
@returns(200)

@endpoint POST /appstore/v1/script_tags.json
@desc スクリプトタグの作成
@optional {script_tag: map # 作成するスクリプトタグの情報}
@returns(200)

@endpoint GET /appstore/v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの取得
@required {scriptTagId: any # スクリプトタグID}
@returns(200)

@endpoint PUT /appstore/v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの更新
@required {scriptTagId: any # スクリプトタグID}
@optional {script_tag: map # 作成するスクリプトタグの情報}
@returns(200)

@endpoint DELETE /appstore/v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの削除
@required {scriptTagId: any # スクリプトタグID}
@returns(204) No Content

@endgroup

@group inline_script_tags.json
@endpoint GET /v1/inline_script_tags.json
@desc インラインスクリプトタグの取得
@returns(200)

@endpoint POST /v1/inline_script_tags.json
@desc インラインスクリプトタグの登録
@optional {inline_script_tag: map # 作成するインラインスクリプトタグの情報}
@returns(201)

@endgroup

@group inline_script_tags
@endpoint GET /v1/inline_script_tags/{inlineScriptTagId}.json
@desc インラインスクリプトタグの取得
@required {inlineScriptTagId: any # インラインスクリプトタグID}
@returns(200)

@endpoint PUT /v1/inline_script_tags/{inlineScriptTagId}.json
@desc インラインスクリプトタグの更新
@required {inlineScriptTagId: any # インラインスクリプトタグID}
@optional {inline_script_tag: map # 更新するスクリプトタグの情報}
@returns(200)

@endpoint DELETE /v1/inline_script_tags/{inlineScriptTagId}.json
@desc インラインスクリプトタグの削除
@required {inlineScriptTagId: any # インラインスクリプトタグID}
@returns(204) No Content

@endgroup

@group script_tags.json
@endpoint GET /v1/script_tags.json
@desc スクリプトタグの取得
@returns(200)

@endpoint POST /v1/script_tags.json
@desc スクリプトタグの作成
@optional {script_tag: map # 作成するスクリプトタグの情報}
@returns(200)

@endgroup

@group script_tags
@endpoint GET /v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの取得
@required {scriptTagId: any # スクリプトタグID}
@returns(200)

@endpoint PUT /v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの更新
@required {scriptTagId: any # スクリプトタグID}
@optional {script_tag: map # 作成するスクリプトタグの情報}
@returns(200)

@endpoint DELETE /v1/script_tags/{scriptTagId}.json
@desc スクリプトタグの削除
@required {scriptTagId: any # スクリプトタグID}
@returns(204) No Content

@endgroup

@group appstore
@endpoint POST /appstore/v1/application_charges.json
@desc アプリ内課金データの作成
@required {application_charge: map}
@returns(201)

@endpoint POST /appstore/v1/recurring_application_charges/{recurringApplicationChargeId}/usage_charges.json
@desc 従量課金データの作成
@required {recurringApplicationChargeId: any # 課金契約ID, usage_charge: map # 従量課金データ}
@optional {X-Appstore-Usage-Charge-Token: any # アンインストール後の従量課金の精算をする際に、 `Authorization` ヘッダへアクセストークンを指定する代わりにこのヘッダを指定することで、このAPIを実行することができます。 インストール中は指定不要で、アンインストール後のみ必須となります。 アンインストールフックで通知される `usage_charge.api_token` の値を指定してください。 このヘッダは、アンインストールフックで通知される `usage_charge.closing_on` まで有効です。この期間を過ぎると従量課金を精算できなくなりますのでご注意ください。詳しくは [アプリのアンインストール](#section/API/アプリのアンインストール) をご確認ください。}
@returns(201)

@endpoint DELETE /appstore/v1/installation.json
@desc アプリストアアプリのアンインストール
@returns(200) アンインストール成功

@endgroup

@end