EC-CUBE Web API ベータ版定義について

webapi-beta.md

• EC-CUBEプラグインとして実装
• PHP5.4～7.0にて動作確認
• PostgreSQL9.2, MySQL5.5, SQLite3 にて動作確認
• 全テーブルの CRUD が可能なこと
  • DELETE は del_flg が存在するテーブルのみ
  • public アクセス可能なテーブル, Customer 認証時に参照/更新可能なテーブル、 フィールドは別途定める
  • API定義は、テーブル構成に依存する
  • パスワード等、暗号化されるデータは変換しない
• パフォーマンスは考慮しない
• 試験的な実装のため、正式リリースまでに仕様が変更される可能性あり
• テストカバレッジ 75%以上確保
• OAuth2.0, OpenID Connect に準拠した認証(Twitter や Facebook, Google 等で広く使われているが、決して手軽ではない)
  • 一部未サポートの仕様あり。
  • セキュティ強化のため「推奨→必須」に変更しているパラメータあり
  • 認証の安全性は SymfonySecurity, php-oauth2-server, EC-CUBE3のプラグインに依存
• シングルサインオンの機能は未実装(クライアント側でログイン共有機能を自力で実装する必要がある)
• API ドキュメント生成に使用している swagger は master ブランチの未リリースのものを使用
• 現状把握している課題
• 不具合等は随時修正する
• 認証関連ドキュメント
• サンプルクライアント にて各種言語の動作確認済み