# アプリの種類

# プライベート アプリ

プライベート アプリを作成すると、カラーミーショップAPI (opens new window) をご利用いただけます。 プライベート アプリはカラーミーショップ デベロッパー (opens new window) で作成することができます。無料でご利用いただけます。

カラーミーショップAPI は OAuth2.0 Authorization Code Grant に従ってショップオーナーから認可を得た上でAPIアクセストークンを発行します。APIのリクエストに必要な内容につきましては、カラーミーショップAPI (opens new window) をご覧ください。

プライベート アプリの作成には以下の入力項目を入力いただく必要がございます。いずれも登録後も変更可能です。

パラメータ 概要
アプリ名 プライベート アプリの名称を入力してください。APIご利用の際の認可画面に表示されます。
リダイレクトURI 認可画面でショップオーナーがAPIの利用を認可した直後にリダイレクトされるURIです。

# アプリストア アプリ

プライベート アプリをアプリストアモードに切り替えて「アプリストア アプリ」にすることで、プライベート アプリで利用できる機能に加えて以下のことができるようになります。

  • カラーミーショップ アプリストア (opens new window) でアプリを販売いただけます。
  • カラーミーショップ API に加えて アプリストア API (opens new window) をご利用いただけます。アプリストア APIでは以下の操作が可能です。
    • ショップページや購入完了画面にスクリプトタグを埋め込むことができます。
    • アプリ利用後に任意の金額を従量課金として請求できます。
  • アプリ販売時に利用料金として月額固定費を請求できます。

注意

  • 切り替えた場合、アプリストア アプリをプライベート アプリに戻すことはできません。プライベート アプリを新規作成してご利用いただくようにご対応ください。
  • 切り変えた場合、プライベート アプリで利用していたアクセストークンは無効化されます。無効化されたアクセストークンではカラーミーショップAPIを利用できなくなりますのでご注意ください。
  • 一度作成したアプリストア アプリは削除できません。

アプリストア アプリに切り替えていただくことで追加の費用などは発生しません。

アプリストア アプリは、プライベート アプリに加えて アプリの最低技術要件 を満たすように開発していただくことで、ショップとの連携やアプリストアへの公開が可能となります。

# アプリストア アプリとショップとの連携

インストール に基づき連携部分を実装していただくことで、カラーミーショップAPI および アプリストアAPI がご利用いただけるようになります。

注意

アプリストア アプリのショップとの連携は、プライベート アプリとショップとの連携方法と異なります。カラーミーショップAPI (opens new window)に示された連携方法ではショップとの連携が行えません。

アプリストア アプリ一覧(要ログイン) (opens new window) から対象のアプリストア アプリを選択し、「インストールテストをする」をクリックすることでショップとの連携をお試しいただけます。