2014年3月26日

カラーミーAPIを試してみた 1

【仕事サイトにカラーミーショップAPI関連記事を書きました】
カラーミーショップAPIの使い方を丁寧に解説します

 カラーミーショップの本気を見た、カラーミーAPI。
Q.何ができるのか? A.むちゃくちゃできます。

太っ腹なことに、一番安いライトプランでも使用可能となっています。
色々と調査していると、すでにアプリケーション(顧客情報からDMを送る、複数のネットショップの在庫管理を一元化する等)が存在するようで、企業がサービスとして提供されているようです。

ここで取り上げるカラーミーAPIの話題は、主にアプリケーションの自作についてです。
(アプリケーションと呼ぶにはおおげさですが)機能追加のための必要データを、サーバから引っ張ってきたり。
ちなみに、参照以外に、更新も可能です(現時点です。今後も機能拡張されるようです)。


カラーミーAPIの使用に際し必要なものは、「カラーミーショップAPIドキュメント」に記載されています。
・カラーミーデベロッパーアカウント → すぐ作れます
・Webサーバ → ヘテムルなど。(私は)PHPを利用することにします


今回のテーマは下記のとおりで、カラーミーAPI利用前の準備編です。
・OAuth2.0やJSONといった用語について
・XAMPP for Windows(PHPのテスト環境)のインストール


1.OAuth2.0とは
カラーミーショップの「カラーミーショップAPIドキュメント」にサンプルがありますので、認証手順については、いちいち理解しなくても事足りますが、一応は読んでおくことをおすすめします。
カラーミーショップAPIドキュメント」中の用語(クライアントID=コンシューマ・キー、認可コード、アクセストークンなど) がチンプンカンプンでは少々心もとないので。
今回はアプリケーションを自作しますので、ユーザー=コンシューマになります。

【参考】
@IT-APIアクセス権を委譲するプロトコル、 OAuthを知る


2.JSON
軽量なデータ記述言語のひとつ。
更新、参照時にデータを送受信する必要がありますが、カラーミーAPIでは、リクエスト、レスポンス、どちらもJSONでやりとりを行います。


3.XAMPP for Windowsのインストール
PHP開発において通常、ローカル環境(たとえば、自分のWindows PC)で作成、テストした後に、サーバ(ヘテムルなど)にアップロードします。
修正→テストのたびに毎回アップロードする手間がかからなかったり、意図しないバグ混入によってサーバに多大な負荷をかけることがなかったり、そんな理由です。
インストール手順と設定については、ネット上に解説記事が数多くあります。セキュリティ設定をするところまでの解説が載っているものを参照してください。
PHPのコーディング自体は、テキストエディタがあれば、いまのところは十分です。

【参考】
XAMPP for Windows のダウンロードとインストールと設定


さて、次回の「カラーミーAPIを試してみた 2」は、「カラーミーショップAPIドキュメント」のサンプルを使って、カラーミーAPIを利用するためのOAuth認証~実際にショップのデータを取得するまで、です。
PHP初学者の方は、「PHPプロ!-PHP基礎講座」で自習しながらお待ちください。
次回につづく!