見出し画像

【開発者向け】カラーミーショップで使えるAPIについて解説

カラーミーショップ アプリストア

こんにちは。カラーミーショップ アプリストア担当者です。
カラーミーショップ アプリストアでは、カラーミーショップユーザーのショップ運営をサポートする機能（アプリ）を販売いただくことができます。

今回は、アプリを開発したいデベロッパーさん向けにカラーミーショップで利用できるAPIについて解説します。
「APIでどんな情報を取得できるの？」「カラーミーショップAPIとアプリストアAPIって何が違うの？」とお悩みの方は、ぜひご参照ください！

カラーミーショップで使えるAPIは2種類

カラーミーショップでは、「カラーミーショップAPI」と「アプリストアAPI」の2種類のAPIをご用意しています。
カラーミーショップAPIはデベロッパー登録後、どなたでもご利用いただけますが、「アプリストアAPI」はデベロッパー登録後、登録したプライベートアプリをアプリストアアプリに変更することで利用できるようになります。
それぞれで利用できる情報についてご紹介します。

カラーミーショップAPI

カラーミーショップで作成したショップの情報や、受注、顧客情報などを取得、更新できるAPIです。
デベロッパーページでデベロッパー登録することで、どなたでもご利用可能です。登録含め、利用料は一切かからないのでまずはAPIをテストしてみたい方は是非ご登録ください。

カラーミーショップAPIでは、主に以下の情報をご利用いただけます。レスポンスのサンプルを確認したい方は、ドキュメントをご参照ください。

ショップ情報

  • ショップ名などショップが登録している基本的な情報をGET（取得）できます。

  • ショップ情報のPOST（新規作成）,PUT（更新）,DELETE（削除）はできません。

受注データ

  • 受注一覧のデータ、売上の集計、個別の受注データの詳細をGETできます。

  • 個別の受注データの情報や、受注のキャンセルをPUTできます。

  • 受注・入金確認・商品発送メールをPOSTできます。

  • 受注データのDELETEはできません。

顧客データ

  • 顧客一覧のデータ、個別の顧客データの詳細をGETできます。

  • 新たに顧客データをPOSTできます。

  • 顧客の情報をPUTすることはできません。

  • 顧客データのDELETEはできません。

商品データ

  • 商品一覧のデータ、個別の商品データの詳細をGETできます。

  • 新たに商品データをPOSTできます。

  • 個別の商品データの情報をPUTできます。

  • 商品データのDELETEはできません。

  • 登録している商品を、ショップのトップページに表示する「おすすめ商品」としてPOSTできます。おすすめ商品の詳細については、こちらの記事をご参照ください。

  • 登録されているおすすめ商品をDELETEできます。

在庫データ

  • ショップの在庫データをGETできます。

  • 在庫データのPOST,PUT,DELETEはできません。

商品グループデータ

グループの詳細についてはこちらをご参照ください。

  • 商品グループ（ユーザーが任意の方法で分類した商品群）の一覧のデータをGETできます。

  • 商品グループデータのPOST,PUT,DELETEはできません。

商品カテゴリー

カテゴリーの詳細についてはこちらをご参照ください

  • 商品カテゴリー（ユーザーが任意の方法で分類した商品群、いち商品につき一つのみ）の一覧のデータをGETできます。

  • 商品カテゴリーのPOST,PUT,DELETEはできません。

決済データ

  • 決済方法などショップが設定している決済の詳細データについてGETできます。

  • 決済データのPOST,PUT,DELETEはできません。

配送データ

  • ショップが登録している配送方法の一覧データ、配送日時設定データをGETできます。

  • 配送データのPOST,PUT,DELETEはできません。

ギフト設定データ

ギフト設定の詳細についてはこちらをご参照ください。

  • ショップが登録しているギフト設定データをGETできます。

  • ギフト設定データのPOST,PUT,DELETEはできません。

ショップクーポンデータ

ショップクーポンの詳細についてはこちらをご参照ください。

  • ショップクーポンの一覧のデータ、個別のショップクーポンデータの詳細をGETできます。

  • ショップクーポンデータのPOST,PUT,DELETEはできません。

アプリストアAPI

アプリストアAPIは、カラーミーショップ アプリストアでアプリを販売いただける方を対象にしたAPIです。デベロッパー登録後、プライベートアプリを登録し、その後、デベロッパーページからアプリストアアプリに変更することで利用が可能になります。
スクリプトタグなど便利なAPIもご用意しているので、是非アプリ開発の際はお役立てください。
アプリストアAPIでは、主に以下の情報をご利用いただけます。レスポンスのサンプルを確認したい方は、ドキュメントをご参照ください。

アプリ内課金データ

アプリストア上で販売しているアプリについて、アプリ内で課金が発生する場合に利用するAPIです。あらかじめ、デベロッパーページ上でアプリ内課金の登録を行い、APIでリクエストすることでアプリユーザーに対して設定したアプリ内課金をリクエストすることができます。

  • アプリ内課金データをPOSTできます。

  • アプリ内課金データのGET,PUT,DELETEはできません。

従量課金データ

アプリストア上で販売しているアプリについて、従量課金で請求が発生する場合に利用するAPIです。毎月利用額に応じて、金額を指定してAPIでリクエストしていただく必要があります。（特定のロジックを設定して自動で金額が算出されるようなシステムではございません。請求金額を利用者別に指定していただく必要がございます。）

  • 従量課金データをPOSTできます。

  • 従量課金データのGET,PUT,DELETEはできません。

スクリプトタグ

カラーミーショップで作成したショップのページにスクリプトタグを設定するAPIです。ただし、カート内ページ及び会員登録ページはセキュリティの関係上タグを設置することができません。
上記ページ内にスクリプトタグを設置したい場合は、お手数ですがお問い合わせまでその旨ご連絡くださいませ。

  • 登録されているスクリプトタグの一覧、スクリプトタグの詳細データをGETできます。

  • スクリプトタグをPOSTできます。

  • 設定されているスクリプトタグをPUTできます。

  • 設定されているスクリプトタグをDELETEできます。

アンインストール

通常、アプリはユーザーの手により利用解除(アンインストール)されますが、APIを利用してデベロッパー側からアプリをアンインストールすることもできます。
強制的にアンインストールを行いたい場合にご利用ください。

  • 登録されているアプリのインストール状態をDELETEできます。（アプリの安心ストールを行います）

  • アプリをPOSTしたり、登録されているアプリをGET,PUTすることはできません。

まとめ

以上がカラーミーショップで利用できるAPIの全てです。うまく活用することで、外部サービスとのデータ連携が行えたり、ユーザーの不便を解消できるツールの開発も可能です。
カラーミーショップ アプリストアでは、こんなAPIも利用したい、というご希望も受け付けております。お問い合わせまでその旨ご連絡ください。
＊すべてのご要望にお応えするものを保証するわけではございません。あらかじめご了承ください。

カラーミーショップでは、ショップの運営をサポートする機能の開発企業を募集しています。

▼デベロッパー登録はこちら

アプリストアでのアプリ開発について知りたい方はこちらから資料ダウンロードいただけます。
また、アプリ開発について問い合わせがございます場合はお問い合わせまでその旨ご連絡ください。専任サポートが開発・リリースまでサポートいたします。



この記事が気に入ったらサポートをしてみませんか？