Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
200 lines (135 sloc) 9.11 KB
title keywords tags sidebar permalink summary
EC-CUBE API β版 プラグイン スタートアップガイド
api startup guide
api
getting_started
home_sidebar
api_startup-guide
EC-CUBE API β版 プラグインの利用方法について簡単な説明です。

本章の内容

  • EC-CUBE API β版

    • インストール方法
    • Swaggerを利用した動作確認方法
    • 開発に必要なドキュメント
  • 対象者

    • OAuth2.0やOpenID Connectによる認証/APIの利用経験のある方を想定しています。
      (Facebook/Twitter/Google連携アプリの作成など)
  • 関連ページ
    API開発指針 Web API Authorization ガイド

β版 基本要件

  1. 全テーブルの CRUD が可能なこと
    • DELETE は del_flg が存在するテーブルのみ
    • public アクセス可能なテーブル、Customer 認証時に参照/更新可能なテーブル、 フィールドは別途定める
    • API定義は、テーブル構成に依存する
    • ハッシュ化されているデータはそのまま文字列として扱う
  2. β版は試験的な実装のため、正式リリースまでに仕様が変更される可能性あり
    • エンドポイントの名前
    • 取得できるデータ構造(EC-CUBE内のテーブルレイアウトに依存)
    • 各テーブルへのアクセス制限
    • など
  3. OAuth2.0/OpenID Connect に準拠した認証
    • 一部未サポートの仕様あり(今後サポート予定)
    • セキュティ強化のためOAuth2.0, OpenID Connectの仕様で「推奨→必須」に変更しているパラメータあり
    • 認証の安全性は SymfonySecurity, php-oauth2-server, EC-CUBE 3.0のプラグイン機構に依存
  4. シングルサインオンの機能はサポートしない
  5. API ドキュメント生成に使用している swagger-ui は master ブランチの未リリースのものを使用(SHA:b856d6c)
  6. PHP5.4以降にて動作確認
  7. PostgreSQL9.2, MySQL5.5, SQLite3 にて動作確認
  8. 現状把握している課題(Issue)

インストール

EC-CUBEオーナーズストアから入手してください。

プラグインダウンロードページ

※β版は試験的なリリースのため本番環境にはインストールしないでください。

public アクセス可能なAPIエンドポイントへのアクセス

  • EC-CUBE APIβ版プラグインインストール後に、下記のURLにアクセスすることで、商品情報を取得できます。

    URL: http://<サイトURL> /api/v0/product
    レスポンス形式: JSON形式

    ※public アクセス可能なAPIの一覧については、本章のAPIエンドポイント一覧を参照してください。

認証が必要なAPIエンドポイントへのアクセス

public アクセス不可のAPIエンドポイントを使用する場合は、クライアントの登録と認証が必要です。
このドキュメントではSwaggerをクライアントとして使用して、動作確認を行います。
以下に手順を示します。

1. APIクライアントの登録

認証を行うにはクライアントの登録が必要です。
管理画面>設定>メンバー管理 からAPIクライアントの追加を行ってください。


EC-CUBE管理API登録画面1


EC-CUBE管理API登録画面2


登録ボタンを押してクライアントの登録を完了します。
このドキュメントではSwaggerを利用して動作確認をするため、「redirect_uri」の項目は登録画面の最下部の説明のとおりに設定してください。


EC-CUBE管理画面Swaggerリダイレクト


2. クライアントとしてSwaggerを利用した動作確認

EC-CUBE 3.0 では、認証方法としてOAuth2.0 Authorization及びOpenID Connectをサポートしています。
この認証に対応したクライアントとして、Swaggerを利用して動作確認を行います。
「APIドキュメントを開く」をクリックするとSwaggerの画面にアクセスできます。


EC-CUBE管理画面Swaggerリンク


3. 認証手順

  1. 画面右上の「Authorize」ボタンを押下します。
  2. 使用したいスコープのチェックボックスをONにして子画面内の「Authorize」ボタンを押してください。
    EC-CUBEの管理画面に遷移するので、ここで「許可する」を選択すると、そのスコープにアクセスできるようになります。
    (内部的にはアクセストークンを取得した状態になります)

Swagger認証


Swagger認証コールバック


  • ご注意
    • Swagger側で選択したスコープに関わらず、全てのスコープに対してリクエストが行われてしまいますが、これはSwagger不具合によるものです。EC-CUBE APIの認証の不具合ではありません。

4. 商品情報をGET(取得)する

  1. 「GET /api/v0/product」を選択します。
  2. 「実際に実行」ボタンを押下すると、商品情報を取得できます。

SwaggerGetSample


5. 商品情報をPOST(作成)する

  1. 「POST /api/v0/product」を選択します。
  2. 画面の①部分にパラメータのサンプルが表示されています。
  3. 画面の①部分をクリックすると、②部分にサンプルが挿入されます。
  4. 「実際に実行」ボタンを押下すると、商品情報を作成できます。

SwaggerPostSample


再度、商品情報をGET(取得)すると、商品情報が追加できている事を確認できます。

レスポンスコードが401の場合は認証に失敗しています。
認証をやり直すか、それでもうまくいかない場合は本章のトラブルシューティングを確認してください。

クライアントの認証フローについて

EC-CUBE 3.0の認証が必要なAPIにアクセスするためには、クライアントにOAuth2.0, OpenID Connectの認証フローを実装する必要あります。
詳細は下記のドキュメントをご確認ください。
Web API認証 ( Authorization ) ガイド

実装サンプル

PHP(Symfony2) での実装例
Python(Flask) での実装例
Node.js(Express) での実装例
C# での実装例(Web/Wpf)
Java での実装例
Google OAuth 2.0 Playground - OAuth 2.0 Configuration -> OAuth endpoint -> Custom にて動作確認済み
- Authorization Endpoint に ?state=<random_state> を付与する必要があります

利用できるAPIエンドポイントについて

EC-CUBE 3.0では、RESTの原則に基づいたAPIの実装を行っています。
詳細は下記のドキュメントをご確認ください。

API開発ドキュメント
http://ec-cube.github.io/api
APIエンドポイント一覧
https://github.com/EC-CUBE/ec-cube.github.io/blob/master/documents/api/EC-CUBE_API_Endpoint.pdf

APIで取得できる情報について

β版ではEC-CUBE 3.0の各テーブルに対してCRUDアクセスを提供しています。
そのためAPIから取得したデータの定義は、EC-CUBE 3.0のテーブル定義に依存します。
EC-CUBE 3.0のテーブル定義は下記を参照してください。

EC-CUBE 3.0テーブル定義
https://github.com/EC-CUBE/eccube3-doc/tree/master/ER-D

トラブルシューティング

  1. 認証したのにレスポンスが401となる

    一部のレンタルサーバーや SAPI CGI/FastCGI の環境では、認証情報(Authorization ヘッダ)が取得できず、 401 Unauthorized エラーとなってしまう場合があります。 この場合は、 /html/.htaccess に以下を追記してください。

    RewriteCond %{HTTP:Authorization} ^(.*)
    RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]