API Support Tool 案内

  • cafe24ECソリューションのAPIを簡単に確認・使用できるよう、グローバルAPIテストプログラムのPOSTMANを
    利用した確認方法を案内しています。POSTMANを活用すると便利にAPI를使用することができます。

cafe24 デベロッパーでAppを登録してAPIを使用するための必須情報を入力

01
  • cafe24 デベロッパーからログインし、Appを新規登録した後、登録されたAppを選択してApp基本情報登録画面へ移動します。
  • APIを通したResponse結果を受信するRedirect URL(s)を入力します。
    認証及びAPI呼び出し結果をもらう時に使用するURLです。(必ずhttpsプロトコル使用)
  • ショップにAPIを利用できるように使用権限を選択して入力します。
    (必ず、「閲覧」、「閲覧+書き込み」の権限をよく選択してください)
  • 認証情報から発行されたApp KeyとApp secret keyを確認します。
  • 保存ボタンをクリックして設定した情報をすべて保存すると、APIを使用するkeyの発行が終了します。
  • 詳細なAppの作成及び情報登録方法は、App作成及び基本設定案内ガイドをご参考ください。

- 実行画面例

POSTMANプログラムを設置し、APIコレクションファイルと環境設定ファイルをダウンロード

02
  • POSTMAN(Webサイト)からプログラムをダウンロードします。   [POSTMAN ショートカット ▶]
    該当プログラムは、無料バージョンの使用が可能であり、1日当たり 1,000回までAPIの テストができます。
  • cafe24 APIコレクションと環境設定ファイルをダウンロードします。   [環境設定ファイルをダウンロード ▶]
    圧縮を解除すると、cafe24 API Environment(Sample).postman_environmentファイルが提供されます。
  • 右にあるボタンをクリックすると、cafe24 APIコレクションが自動で設置されます。

- 実行画面例

ダウンロードしたAPIコレクションファイルと環境設定ファイルをPOSTMANに適用

03
  • APIコレクションファイル適用方法
    ページ上部の ボタンをクリックすると、APIコレクションが自動に適用されます。

  • 環境設定ファイル適用方法
    ① POSTMANプログラムの右上の ボタンをクリック後、「Manage Environment」をクリックします。
    ② Manage Environmentポップアップの下部にある「Import」ボタンをクリック後、ダウンロードしたenvironmentファイルをアップロードします。
    ③ 環境設定の選択一覧に「cafe24 API Environment(Sample)」が追加されているかを確認します。
    ④ 追加された「cafe24 API Environment(Sample)」をクリックし、環境設定ポップアップをオープンします。
    ⑤ mallid、domain、client_secret、client_idを修正します。
    環境設定ファイル適用方法
    Key Value
    mallid テストするショップID
    redirect_uri cafe24 デベロッパーで入力したRedirect_URL(s)
    client_secret cafe24 デベロッパーで発行されたApp secret key
    client_id cafe24 デベロッパーで発行されたApp Key

- 実行画面例

環境設定とAPIコレクションの準備ができたら、Access Tokenを発行

04
  • APIコレクションで「Authorize Access Token」をクリックします。
  • TYPEで「Oauth 2.0」選択後、「Get New Access Token」をクリックします。
  • ポップアップ画面で下記の内容を入力します。(赤文字は、記載どおりに、そのまま入力)
    環境設定とAPIコレクションの準備ができたら、Access Tokenを発行
    Key Value
    Token Name 発行Tokenの名前 - 開発元にて自由に入力可能
    Grant Type 「Authorization Code」選択
    Callback URL {{redirect_uri}}
    - (修正せずにそのまま入力)
    Auth URL https://{{mallid}}.cafe24api.com/api/v2/oauth/authorize
    - (修正せずにそのまま入力)
    Access Token URL https://{{mallid}}.cafe24api.com/api/v2/oauth/token
    - (修正せずにそのまま入力)
    Client ID {{client_id}}
    - (修正せずにそのまま入力)
    Client Secret {{client_secret}}
    - (修正せずにそのまま入力)
    Scope リクエストするAPIの権限範囲
    (例:mall.write_category、mall.write_order、mall.write_product...)
    *詳細なScope値は、API権限(Scope) ガイドをご参考ください。
    State 偽装攻撃を防止するための任意の値 - 開発元にて自由に入力可能

- 実行画面例

  • 入力完了後、「Request Token」をクリックするとショップのログイン画面が表示されます。ログイン画面で管理者アカウントでログインします。
  • ログインすると、ポップアップ画面が表示されます。このポップアップ画面でAccess TokenとRefresh Tokenをコピーして、メモ帳に保存しておきます。
  • Postmanプログラム右上の ボタンをクリックし、表示されたメニューで「Edit」ボタンをクリックします。
  • コピーしたAccess Tokenを「access_token」項目に貼り付けた後、「Update」ボタンをクリックします。

- 実行画面例

Refresh Tokenを適用すると、使用期間が満了した後にも便利にTokenを再発行してAPIを使用可能

05
  • POSTMANプログラムのcaef24 API Collectionの中で「Authorize Access Token(Refresh Token)」を選択します。
  • cafe24 デベロッパーで発行されたApp keyとApp secret keyをbase64エンコードを利用して下記のような形に変換します。
エンコードフォーマット: {{app key}:{{app secret key}}

例) App keyが「111」で、App secret keyが「222」の場合、111:222の形に作ってbase64エンコード

[base64エンコードサポートサイト ショートカット ▶]


  • 「grant_type」にrefresh_tokenを入力し、メモ帳などにコピーしておいたRefresh TokenをBodyタブの「refresh_token」に貼り付けた後、「Send」ボタンをクリックするとRefresh Tokenを取得することができます。

  • 取得したRefresh TokenをコピーしてPOSTMANプログラム上部の ボタンと「Edit」ボタンをクリックしてManage Environmentポップアップを呼び出した後、access_tokenに貼り付けます。

以後、POSTMANプログラムですべてのAPIを自由に確認および使用

06
  • 提供したcafe24 API Collectionで、確認したいAPIを選択した後、呼び出すと結果値を確認することができます。

- API呼び出し例(商品一覧API)