基本開発プロセス

  • cafe24のECソリューションと連携し、動作できるアプリケーション(App)を開発するための基本開発ガイドです。
  • App開発時に、基本的に知っておくべき内容を確認できます。

App基本概念および用語

  • Appは、アプリケーション(Application)の略語。提供するAPIを利用してECソリューションと共に動作できるよう作られた多様なプログラムを意味します。ECソリューションと連携できるAppの制限はなく、提供されるサービスがECソリューションと調和すれば、どのようなサービスもAppとの制作およびサービスができます。
  •  
  • クリエイティブで多様なAppを開発するため、ガイドの確認とコミュニケーションでの混乱が発生しないよう、基本的な用語を下記に定義しています。用語の意味を熟知すると、明確なコミュニケーションができ、より簡単にAppの開発が可能となります。
エラーコード仕組み
用語 説明
APP アプリケーション(Application)の略語。cafe24 ECプラットフォームのAPIを利用して制作され、ECプラットフォームと動作できるように作られたプロフラムを意味します。
Appは、WebとMobile(IOS、Android)から駆動する全てのサービスを称します。
Appは、App Storeを通してショップ管理者に販売することができ(利用料の課金が可能)、サービスを提供する開発元の独立したソースコードを利用して駆動されます。
API アプリケーション・プログラミング・インターフェース(Application Programming Interface)の略で、cafe24ECプラットフォームとアプリケーション、サービス、ライブラリなどの標準化された規約に相互の通信を行うことができるインタフェースを意味します。
RESTfulな方式で提供され、必ず定められた規約(インタフェース、パラメータなど)を通じて通信が行われます。
Admin APIとFront APIに分けられており、Front APIは、認証を受けなくても呼び出しが可能なAPIで構成されています。
クライアントID WebサービスのID。Appがショップにアクセスしてデータを照会、生成、削除などをするために認証されたユーザであることを証明するIDを言います。
cafe24 デベロッパーからAppを作成時、発行されるApp keyと同一です。
クライアント
シークレット
Webサービスでのパスワード。Appがショップにアクセスしてデータを照会、生成、削除などをするために認証されたユーザであることを証明するパスワードを言います。
cafe24 デベロッパーからAppを作成時、発行されるApp secret keyと同一です。
App secret Keyは、パスワードのようにセキュリティ上、重要な値のため、再設定が可能ですが、以前使っていたsecret Keyは使用できません。
APP URL Appのサービスを提供するために最初アクセスするURLです。通常、Appの紹介や課金情報、購買を決定する重要な要因になる情報が含まれている、実際サービスを実行する開発元のランタイム(Runtime)サーバーのURLを意味します。
Redirect URL(s) AppがAPIにリクエスト(request)を送信した後、結果(response)を転送されるURLのリストです。
複数のAPIの呼び出し結果はが転送可能ですが、必ずSSL(https)プロトコルで通信する必要があります。
リクエスト
パラメータ
APIを呼び出し(request)する時、リクエストする情報をサーバーに転送する値がパラメータ(parameter)です。API別に使用するパラメータは、いずれも異なるものが提供されます。詳細なパラメータは、API開発ガイドから確認いただけます。
HTTP Method Webを利用したAPI通信をする時、リクエストとレスポンスデータについての役割を定義するプロトコルです。
cafe24 APIは通常、GETㆍPOSTㆍPUTㆍDEL方式のAPI通信を提供しています。
APIを呼び出しするため、4つのメゾット(Method)の一つを使用していますが、クロス使用は不許可しています。(例:POST方式でPUT使用)
APIが提供しているメゾットはAPI開発ガイドから確認できます。
HTTP Status HTTPステータスコードと呼ばれ、APIを呼び出し(Request)する場合、呼び出し結果(Response)の値をステータスコードと返されます。ステータスコードは、IANAから定義したHTTP Response Codeを基に拡張した値を提供しています。
cafe24 APIから提供された詳細なステータスコードを確認したい場合は、ステータスコードおよびエラーメッセージをご参考ください。
OAuth 2.0 2008年11月 IETFから正式に発足し、発展。RFC 6749ドキュメントで標準化したセキュリティ/認証方式です。
Webサービスで通常のログイン(ID, パスワードが必要なログイン)方式と類似にIDに該当するClient ID(App Key)とパスワードに該当するClient secret (App secret key)を利用して認証(request_token)した後、権限(access_token)を確認する方式として認証されます。
一般的にGoogle、 Facebook等のサービスで広く利用されている体形的なセキュリティ方式で、cafe24のサービスはOAuth2.0を遵守したサービスを提供しています。
より詳細な内容は、認証/セキュリティ開発ガイドをご参考ください。
Access_Token ECプラットフォームにログインする際に作られ、ユーザー、ユーザーグループ情報など、ユーザーを識別に必要な情報が含まれているトークン(token)です。 実際、APIを呼び出しする際、必要なユーザー認証トークンです。
Refresh_Token Access_tokenの使用周期は比較的短いです。(一般的に1時間有効) Access_Tokenが満了になるとセキュリティのため、新しいトークンを発行してから継続的に使用することが可能です。この際、Refresh_Tokenを使用して再 ログインなしでAccess_tokenの更新も可能です。
より詳細な内容は、セキュリティ/認証開発ガイドをご参考ください。
RESTful RESTfulは公式に発表した方式ではありませんが、開発者達が長期間、非公式に意見を交わし、RESTを目的と方向性に合わせるため、定義された方式です。 リソース(Resource)の代表(Representation)によるステータス転送を意味します。
cafe24 APIは、RESTfulを基にCRUD(作成、照会、修正、削除)の機能を明確に定義し、提供しています。詳細については、API 開発ガイドをご参考ください。
URI インターネットにあるリソースを表す雄一のアドレスを意味します。URIの存在は、インターネットから要求される基本条件として、プロトコルに常に付いています。よく知られているURLはURIの種類の一つです。
cafe24のURIは、SSL(httpsプロトコル)方式での通信区間のみ提供しています。

App基本仕組み

  • cafe24のECプラットフォームから購入及び使用できるAppを開発するためには下記のような仕組みを勧めてしています。下記の仕組みを参考されると、より円滑なApp開発ができます。

App実行プロセス

  • App実行プロセスは、ショップからApp Storeを通してAppを購入する時点からAppを利用するまでAppとECプラットフォームの間で処理される基本プロセスを案内します。

認証/セキュリティ処理

  • cafe24 デベロッパーを通じて発行されたAPI key、API secret keyを利用し、API呼び出しに対する権限や使用認証及び許可を得てから正常にAPIの使用が可能です。
  • cafe24の認証/セキュリティシステムは、標準化されたOAuth 2.0を基に強力で体形的なセキュリティシステムを提供します。
  • セキュリティシステムに対する適用において、例外的な方法は提供していません。
  • 認証とセキュリティに対する政策及び開発は、認証/セキュリティ開発ガイドをご参考ください。

cafe24 API使用

  • cafe24のECプラットフォームと連携できる多様な種類のAPIを提供しています。APIは基本RESTful方式でサービスされ、APIについて基本的な開発知識があれが、誰でも簡単に使用できます。
  • APIは、ECプラットフォームの機能改善に合わせ、持続的にアップデートされています。
  • 詳細なAPIの種類および仕様・活用方法は、API 基本ガイドをご参考ください。

ショップ運営者ごとの権限処理

  • cafe24のECプラットフォームは、代表運営者・副運営者・供給会社の運営者を区分して管理できます。よって、Appでも運営者ごと権限を区分して管理する必要があります。
  • Appでショップ運営者ごと権限を設定する必要がある場合やショップで設定する運営者ごと権限を確認したい場合は、運営者の権限開発ガイドをご参考ください。

スクリプト(Script)処理規則

  • cafe24 デベロッパーでは、複数の開発元で制作するApp間のスクリプト競合を防止するため、ネームスペース(名前空間)処理を勧めています。
  • ネームスペースを処理をしない場合、App間のスクリプト競合によりエラーが発生する場合があります。
  • スクリプトのネーミング(naming)、ネームスペース(name space)の使用法およびガイドは、Javascript開発ガイドをご参考ください。

App Script自動反映処理

  • Appを制作後、cafe24のショップにAppを設置時、Appから使用しているスクリプト(Script)がある場合、Appから希望するネットショップ画面にスクリプト(Script)をAPIを利用して自動に適用できます。
  • 詳細なスクリプトの適用方法および画面コードに関する開発ガイドは、ショップ画面仕組みおよびAPI活用ガイドをご参考ください。