Admin APIを利用したサンプルソース

  • 初期にApp開発を開始する段階でより簡単に開始できるようにサンプルを提供しています。
  • サンプルリファレンスは、基本となる必須コードのみで構成されているため、必ず参考用としてのみご使用ください。
  • サンプルリファレンスソースコードは、php基盤で作成されたコードを提供します。

基本構造

Access_Tokenを取得してAPIを呼び出し、リターンデータを得ることに対する基本仕組みは、以下のようになります。

トークンを利用したAPI呼出サンプルソースコード

1. ショップ運営者がAppを実行

  • ショップ運営者がAppを実行すると、cafe24 デベロッパーでApp作成時に入力したApp URLパスでAppを最初実行します。
  • 以下のサンプルソースは、Appを最初に実行する際に表示されるページを指します。
  • - Appが実行される際に、以下の形式でAppを実行したショップおよび運営者の情報が送信されます。

https://{{AppUrl}}/?is_multi_shop={{マルチショップ可否}}&lang={{ショップ言語}}&mall_id={{ショップID}}&shop_no={{shop_no}}×tamp= {{timestamp}}&user_id={{ログインID}}&user_name={{ログインユーザー名}}&user_type={{ユーザータイプ}}&hmac={{検証用 key}}

2. ショップ運営者にAPI呼出に対する権限同意の承認要請

  • ショップ運営者にAPI呼出に対する権限の同意を得た上で(Access_Tokenを取得して) App設置を要請するステップです。
  • 1) '$sMallID' : ショップID
  • API権限を要請するショップIDを入力します。
  • 実際のサービスステップでは、Appが設置されたショップIDがAppにパラメータとして送信されます。(1番のショップおよび運営者情報を参考、または下の内容を参考)
  • 2) '$sClientID' : クライアントID(App Key)
  • cafe24 デベロッパーから取得したApp Keyを入力します。
  • 3) '$sAuthCodeReceiveUrl' : cafe24 デベロッパーRedirect URL(s)に登録されたURL
  • cafe24 デベロッパーで入力したリターン認証コードを処理するURLであるRedirect URL(s)を入力します。
  • Redirect Url(s)を複数入力し、入力された各URLそれぞれにコード発行トークンを取得したい場合はコンマ(、)で入力することができます。
  • 4) '$sScope' : ショップAPI権限(Scope)情報
  • APIを利用して取得したショップデータの権限を入力してください。(詳細内容は 「API 権限(Scope)ガイド」 参考)
  • - 入力例 : 商品カテゴリ(閲覧権限)、商品(閲覧+書き込み権限)をcafe24 デベロッパーで指定した後にソースコードに反映する場合
  • * APIの使用権限が追加/変更/削除される場合、必ずショップに変更された権限に対して同意した後、Access_Tokenを再発行してください。正常なAPI呼出のためにAccess_Tokenが必要となります。

3. 資格証明(access_token)要請

  • AppでAPIを呼び出すためのAccess_Token発行ステップです。

4. 認証済みのAPI呼出

  • Appから取得したAccess_Tokenを利用してAPIを呼び出すステップです。

スクリプト自動設置サンプルソースコード

  • Appでcafe24 ECプラットフォームのFront画面にスクリプト(Script)を挿入する場合、スクリプトAPIを通して簡単に挿入したい画面にスクリプトを設置(挿入)することができます。設置する画面名は画面コードAPIを通して確認することができます。
  • ショップのFrontに反映されるスクリプト(Script)は、開発会社のランタイムサーバーのスクリプトを呼び出すことで動作します。

例) Front画面にスクリプトを自動設置するソースコード(PHPソースとして提供)