EC事業者様の海外販売をJ-goods(弊社提供の貴社専用越境ECサイト)でお手伝い

他社API連携

1.概要

他社API連携には以下の機能があります。

  • 商品情報の取得

    以下のデータを取得して表示することができます。

    商品情報は、一度、J-goodsのデータベースに取り込んで使用します。そのため海外向けに価格や説明を変更することも可能です。
  • 在庫情報の変更

    お客様が決済を完了した時点で、外部DBにて在庫引き当てを行うことが可能です。

  • 受注情報の取得

    独自APIを利用することで、受注状況が変化した際、受注情報をJ-Goodsから送信させることができます。
    貴社基幹システム上で在庫管理をする場合などにお役立てください。

2.他社API連携の利用手順

他社API連携を利用するために必要な作業は次のとおりです。

  1. 他社API連携の設定

    J-goods上でどのAPIを利用するかを設定します。
    ●商品情報の取得先
    ●在庫の変更先
    ●更新項目の設定

  2. 商品情報の取り込み

    各ネットショップから商品情報を取り込みます。

  3. カテゴリ情報の取り込み

    カラーミーBaseショップサーブ についてはカテゴリ情報を取り込むことが可能です。
    カラーミーBaseは独自カテゴリ編集画面でカテゴリ情報を取り込みます。
    ショップサーブは商品情報取り込み時に自動的にカテゴリ情報も取り込んで登録します。
    MakeShopはAPIの制限により、カテゴリ情報を取り込むことができません。ご了承ください。

3.他社API連携の設定

他社API連携を利用するには「他社API連携設定」で設定を行う必要があります。
各APIを利用する際の設定については、それぞれのAPIに関する説明をご覧ください。

ここでは全体の流れを説明します。

  1. 通販事業者様用mypageにログイン後、メニューの「登録情報変更」リンクをクリックしてください。

    登録情報変更リンクをクリック
  2. 他社API連携」のリンクをクリックしてください。

    他社API連携リンクをクリック
  3. 他社API連携設定画面が表示されます。ここで商品情報の取得先、在庫情報の変更先を設定してください。

    認証用パスワードの指定

    商品情報の取得先、在庫の変更先を設定したなら、確認ボタンをクリックしてください(選択した項目によってはさらに入力欄が表示される場合があります)。

    組み合わせ可能な商品情報の取得先と在庫情報の変更先は次のとおりです。

    商品情報取得先 在庫情報変更先 備考
    J-goods J-goods J-goodsに登録された商品データを使用します。
    在庫の増減もJ-goods上のデータに対して行います。
    独自API J-goodsに登録された商品データを使用します。
    受注情報を貴社の基幹システムに送信します。自社内で在庫管理を行いたい場合に使用します。
    ネクストエンジン J-goodsに登録された商品データを使用します。
    受注情報をネクストエンジン宛てにメールで送信します。
    zaiko Robot J-goodsに登録された商品データを使用します。
    受注情報をzaiko Robot宛てにメールで送信します。
    カラーミー J-goods 商品データはカラーミーから取り込みます。
    カラーミー上の在庫は管理しません。
    独自API 商品データはカラーミーから取り込みます。
    受注情報を貴社の基幹システムに送信します。カラーミー上の在庫は管理しません。
    カラーミー 商品データはカラーミーから取り込みます。
    カラーミーの在庫も操作します(※カラーミー上で在庫を管理する設定になっている場合のみ)。 J-goodsに取り込んだ商品の在庫も同時に変更されます。
    ネクストエンジン 商品データはカラーミーから取り込みます。
    受注情報をネクストエンジン宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    zaiko Robot 商品データはカラーミーから取り込みます。
    受注情報をzaiko Robot宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    Base J-goods 商品データはBaseから取り込みます。
    BASE上の在庫は管理しません。
    独自API 商品データはBASEから取り込みます。
    受注情報を貴社の基幹システムに送信します。BASE上の在庫は管理しません。
    Base 商品データはBASEから取り込みます。
    BASEの在庫も操作します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    ネクストエンジン 商品データはBASEから取り込みます。
    受注情報をネクストエンジン宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    zaiko Robot 商品データはBASEから取り込みます。
    受注情報をzaiko Robot宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    MakeShop J-goods 商品データはMakeShopから取り込みます。
    MakeShop上の在庫は管理しません。J-goodsに取り込んだ商品の在庫のみ変更されます。
    独自API 商品データはMakeShopから取り込みます。
    受注情報を貴社の基幹システムに送信します。MakeShop上の在庫は管理しません。
    MakeShop 商品データはMakeShopから取り込みます。
    MakeShopの在庫も操作します(※MakeShop上で在庫を管理する設定になっている場合のみ)。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    ネクストエンジン 商品データはMakeShopから取り込みます。
    受注情報をネクストエンジン宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    zaiko Robot 商品データはMakeShopから取り込みます。
    受注情報をzaiko Robot宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    ショップサーブ J-goods 商品データはショップサーブから取り込みます。
    ショップサーブ上の在庫は管理しません。J-goodsに取り込んだ商品の在庫のみ変更されます。
    独自API 商品データはショップサーブから取り込みます。
    受注情報を貴社の基幹システムに送信します。ショップサーブ上の在庫は管理しません。
    ショップサーブ 商品データはショップサーブから取り込みます。
    ショップサーブの在庫も操作します(※ショップサーブ上で在庫を管理する設定になっている場合のみ)。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    ネクストエンジン 商品データはショップサーブから取り込みます。
    受注情報をネクストエンジン宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
    zaiko Robot 商品データはショップサーブから取り込みます。
    受注情報をzaiko Robot宛てにメールで送信します。J-goodsに取り込んだ商品の在庫も同時に変更されます。
  4. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると情報が登録されます。

  5. 登録完了画面が表示されます。

    登録完了画面
  6. 一定の時間内に入力が終わらなかった場合は、エラーメッセージが表示されます。その場合はお手数ですが、最初から入力をやり直してください。

    時間超過エラー画面

4.カラーミーAPIを使用する

カラーミーAPIを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先として「カラーミー」を選択します。
    • 在庫の変更先を選択します。選択できるのは、「J-goods」、「独自API」、「カラーミー」、「ネクストエンジン」、「zaiko Robot」のいずれかです。
    • 消費税の処理を選択します。
      1. 御社の消費税について
        「免税事業者」を選択するとデータ取り込み時の税抜き処理を行いません。税抜き処理を実行したい場合は「課税事業者」を選択してください。
      2. 販売価格の登録形式
        カラーミーに登録した価格が、税込み価格なのか税抜き価格なのかを設定します。「税抜き価格」を選択するとデータ取り込み時の税抜き処理を行いません。税抜き処理を実行したい場合は「税込価格」を選択してください。
      3. 消費税額の端数処理
        税抜き価格から税込み価格を計算する際の端数処理を設定します。お客様の処理に応じて設定してください。
    • 更新する商品情報の項目を設定します。チェックされた項目が存在しない場合、商品情報は更新されません。
      商品情報は商品詳細ページが表示されたタイミングで更新されます。ただし前回の更新から60分以上経過していない場合には更新されませんのでご注意ください。
    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると、カラーミーのページに遷移します。

  3. カラーミーのログイン画面が表示されます。

    カラーミーログイン画面

    カラーミーのログインIDとパスワードを入力して、ログインボタンをクリックしてください。認証されると、J-goodsのサイトに戻ってきます。

  4. カラーミーで認証されるとJ-goodsに遷移し、登録完了画面が表示されます。

    登録完了画面
  5. 続いて商品情報を取り込みます。メニューの「商品データ管理」リンクをクリックしてください。

    商品データ管理をクリック

    商品情報一覧画面が表示されます。

  6. カラーミーから商品データを取り込みます。商品情報一覧画面の新規登録ボタンをクリックしてください。

    商品情報一覧画面
  7. データ取り込みダイアログが表示されます。ダイアログの取り込み開始ボタンをクリックするとデータの取り込みが始まります。

    データ取り込みダイアログ
  8. 取り込むデータ数が多い場合には、取り込んだ件数がダイアログに表示されます。取り込みが終了するとダイアログが閉じ、取り込んだデータが画面に表示されます。

    商品情報一覧画面(データ取り込み後)
  9. 続いてカテゴリ情報を取り込みます。
    画面下部の商品カテゴリの設定ボタンをクリックします。

    商品カテゴリの設定ボタンをクリック

    独自カテゴリ編集画面が表示されます。

  10. 独自カテゴリ編集画面にある以下の三つのボタンをいずれかを用いて、カテゴリ情報を取り込みます。

    1. カテゴリ情報の取り込み
      既存のすべてカテゴリ情報を削除し、新たにカテゴリ情報を取り込みなおします。
      既存のカテゴリ情報はすべて削除されますのでご注意ください。
    2. カテゴリ情報の更新
      既存のカテゴリ情報を更新します。新たなカテゴリ情報は追加されません。
    3. カテゴリ情報の追加
      登録されていないカテゴリ情報を追加します。既存のカテゴリ情報は更新されません。

    カテゴリ情報を取り込む

    それぞれのボタンをクリックするとダイアログが表示されます。ダイアログの説明に従ってダイアログにあるボタンをクリックしてください。
    カテゴリ情報の取り込みが終了するとダイアログが閉じ、取り込んだカテゴリ情報が表示されます。

    取り込んだカテゴリ情報を表示

    独自カテゴリの編集方法については「独自カテゴリの登録方法」のページをご覧ください。

5.BASE APIを使用する

BASE APIを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先として「BASE」を選択します。
    • 在庫の変更先を選択します。選択できるのは、「J-goods」、「独自API」、「BASE」、「ネクストエンジン」、「zaiko Robot」のいずれかです。
    • BASE上のショップIDを指定してください。
    • 消費税の処理を選択します。
      1. 御社の消費税について
        「免税事業者」を選択するとデータ取り込み時の税抜き処理を行いません。税抜き処理を実行したい場合は「課税事業者」を選択してください。
      2. 消費税額の端数処理
        税抜き価格から税込み価格を計算する際の端数処理を設定します。お客様の処理に応じて設定してください。
    • 更新する商品情報の項目を設定します。チェックされた項目が存在しない場合、商品情報は更新されません。
      商品情報は商品詳細ページが表示されたタイミングで更新されます。ただし前回の更新から60分以上経過していない場合には更新されませんのでご注意ください。
    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると、BASEのページに遷移します。

  3. BASEのログイン画面が表示されます。

    BASEログイン画面

    BASEに登録してあるメールアドレスとパスワードを入力して、「アプリを認証する」ボタンをクリックしてください。認証されると、J-goodsのサイトに戻ってきます。

  4. BASEで認証されるとJ-goodsに遷移し、登録完了画面が表示されます。

    登録完了画面
  5. 続いて商品情報を取り込みます。メニューの「商品データ管理」リンクをクリックしてください。

    商品データ管理をクリック

    商品情報一覧画面が表示されます。

  6. BASEから商品データを取り込みます。商品情報一覧画面の新規登録ボタンをクリックしてください。

    商品情報一覧画面
  7. データ取り込みダイアログが表示されます。ダイアログの取り込み開始ボタンをクリックするとデータの取り込みが始まります。

    データ取り込みダイアログ
  8. 取り込むデータ数が多い場合には、取り込んだ件数がダイアログに表示されます。取り込みが終了するとダイアログが閉じ、取り込んだデータが画面に表示されます。

    商品情報一覧画面(データ取り込み後)
  9. 続いてカテゴリ情報を取り込みます。
    画面下部の商品カテゴリの設定ボタンをクリックします。

    商品カテゴリの設定ボタンをクリック

    独自カテゴリ編集画面が表示されます。

  10. 独自カテゴリ編集画面にある以下の三つのボタンをいずれかを用いて、カテゴリ情報を取り込みます。

    1. カテゴリ情報の取り込み
      既存のすべてカテゴリ情報を削除し、新たにカテゴリ情報を取り込みなおします。
      既存のカテゴリ情報はすべて削除されますのでご注意ください。
    2. カテゴリ情報の更新
      既存のカテゴリ情報を更新します。新たなカテゴリ情報は追加されません。
    3. カテゴリ情報の追加
      登録されていないカテゴリ情報を追加します。既存のカテゴリ情報は更新されません。

    カテゴリ情報を取り込む

    それぞれのボタンをクリックするとダイアログが表示されます。ダイアログの説明に従ってダイアログにあるボタンをクリックしてください。
    カテゴリ情報の取り込みが終了するとダイアログが閉じ、取り込んだカテゴリ情報が表示されます。

    取り込んだカテゴリ情報を表示

    独自カテゴリの編集方法については「独自カテゴリの登録方法」のページをご覧ください。

6.MakeShop APIを使用する

MakeShop APIを利用する場合は次のように設定します。

  1. MakeShop APIを利用するには、MakeShopの管理画面で認証コードを取得する必要があります。
    認証コードを確認するには、MakeShopの管理画面で「ショップ作成」→「外部システム連携」→「商品データ連携設定」と進んでください。

    なお「外部システム連携」メニューは弊社からMakeShopに申請しなければ表示されません。表示されない場合は、貴社メイクショップの登録者名、ショップ名、ショップIDおよびショップURLを問い合わせフォームを利用してJ-goodsまでお知らせください。申請許可には、2~3営業日かかります。

    MakeShopの管理画面
  2. 認証コードが取得できるようになったなら他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先として「MakeShop」を選択します。
    • 在庫の変更先を選択します。選択できるのは、「J-goods」、「独自API」、「MakeShop」、「ネクストエンジン」、「zaiko Robot」のいずれかです。
    • MakeShopのショップIDを入力します。
    • MakeShopの在庫引当を行う場合は、MakeShopショップパスワードを入力する必要があります。
      入力されたパスワードは暗号化されて保存されますので、万一、当データが漏洩した場合でも解読することはできません。ただパスワードの登録をためらわれる場合は、在庫引当のご利用はお控えください。
    • MakeShop提供のAPIを利用するには、弊社からMakeShopに対し、貴社のメイクショップIDを通知する必要があります。当機能をご利用になる前に貴社のメイクショップIDを問い合わせフォームを利用してお知らせください。申請許可には、2、3営業日かかります。申請が許可されるとMakeShopの管理画面から認証コードを発行できるようになります。
      認証コードを確認するには、MakeShopの管理画面で「ショップ作成」→「外部システム連携」→「商品データ連携設定」と進んでください。
    • 消費税の処理を選択します。
      1. 御社の消費税について
        「免税事業者」を選択するとデータ取り込み時の税抜き処理を行いません。税抜き処理を実行したい場合は「課税事業者」を選択してください。
      2. 販売価格の登録形式
        MakeShopに登録した価格が、税込み価格なのか税抜き価格なのかを設定します。
        MakeShop管理画面で「ショップ作成」→「決済・注文関連の設定」→「消費税の設定」と進んで表示される「消費税設定」での設定に応じて指定してください。
        「税抜き価格」を選択するとデータ取り込み時の税抜き処理を行いません。税抜き処理を実行したい場合は「税込み価格」を選択してください。
      3. 消費税額の端数処理
        税抜き価格から税込み価格を計算する際の端数処理を設定します。お客様の処理に応じて設定してください。
    • 更新する商品情報の項目を設定します。チェックされた項目が存在しない場合、商品情報は更新されません。 商品情報は商品詳細ページが表示されたタイミングで更新されます。ただし前回の更新から60分以上経過していない場合には更新されませんのでご注意ください。
    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  3. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携設定画面

    送信ボタンをクリックすると、登録完了画面が表示されます。

    登録完了画面
  4. 続いて商品情報を取り込みます。メニューの「商品データ管理」リンクをクリックしてください。

    商品データ管理をクリック

    商品情報一覧画面が表示されます。

  5. MakeShopから商品データを取り込みます。商品情報一覧画面の新規登録ボタンをクリックしてください。

    商品情報一覧画面
  6. データ取り込みダイアログが表示されます。ダイアログの取り込み開始ボタンをクリックするとデータの取り込みが始まります。

    データ取り込みダイアログ
  7. 取り込むデータ数が多い場合には、取り込んだ件数がダイアログに表示されます。取り込みが終了するとダイアログが閉じ、取り込んだデータが画面に表示されます。

    商品情報一覧画面(データ取り込み後)
  8. MakeShop APIの場合、カテゴリを取り込むためのAPIが提供されていないためカテゴリを取り込むことができません。
    必要に応じて独自カテゴリ編集画面で、カテゴリを作成してください。

    独自カテゴリの編集方法については「独自カテゴリの登録方法」のページをご覧ください。

7.ショップサーブ APIを使用する

ショップサーブ APIを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先として「ショップサーブ」を選択します。
    • 在庫の変更先を選択します。選択できるのは、「J-goods」、「独自API」、「ショップサーブ」、「ネクストエンジン」、「zaiko Robot」のいずれかです。
    • ショップサーブのショップIDを入力します。
    • ショップサーブのサイトで発行されたオープン認証キーを入力します。オープン認証キーはショップサーブの「Eストアショップサーブ管理画面」からサーバー→ショップサーブAPIへとメニューを進んでいただくと確認できます。
      ショップサーブの「ショップサーブAPI画面」
    • ショップサーブのサイトで発行されたマネジャー認証キーを入力します。マネジャー認証キーはショップサーブの「Eストアショップサーブ管理画面」からサーバー→ショップサーブAPIへとメニューを進んでいただくと確認できます。
    • ショップURLを入力します。ショップサーブの「URL一覧画面」に掲載されている「トップページ」の末尾のindex.htmlを省いて入力してください。トップページはショップサーブの「Eストアショップサーブ管理画面」からサーバー→URL一覧へとメニューを進んでいただくと確認できます。
      ショップサーブの「URL一覧画面」
    • ショップサーブではAPIで税抜き価格を取得できるため,税抜き価格計算の設定は必要ありません。
    • 更新する商品情報の項目を設定します。チェックされた項目が存在しない場合、商品情報は更新されません。 商品情報は商品詳細ページが表示されたタイミングで更新されます。ただし前回の更新から60分以上経過していない場合には更新されませんのでご注意ください。
    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携設定画面

    送信ボタンをクリックすると、登録完了画面が表示されます。

    登録完了画面
  3. 続いて商品情報を取り込みます。メニューの「商品データ管理」リンクをクリックしてください。

    商品データ管理をクリック

    商品情報一覧画面が表示されます。

  4. ショップサーブから商品データを取り込みます。商品情報一覧画面の新規登録ボタンをクリックしてください。

    商品情報一覧画面
  5. データ取り込みダイアログが表示されます。ダイアログの取り込み開始ボタンをクリックするとデータの取り込みが始まります。

    データ取り込みダイアログ
  6. 取り込むデータ数が多い場合には、取り込んだ件数がダイアログに表示されます。取り込みが終了するとダイアログが閉じ、取り込んだデータが画面に表示されます。

    商品情報一覧画面(データ取り込み後)
  7. ショップサーブ APIの場合、商品データを取り込む際に必要に応じて自動的にカテゴリを登録します。
    さらにカテゴリを追加する必要がある場合には、独自カテゴリ編集画面でカテゴリを追加してください。

    独自カテゴリの編集方法については「独自カテゴリの登録方法」のページをご覧ください。

8.ネクストエンジンを使用する

ネクストエンジンの「汎用カート」を利用して在庫を管理することが可能です。「汎用カート」の詳しい説明についてはネクストエンジン様のWEBサイトをご参照ください。

ネクストエンジンを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先を選択します。指定できるのは、「J-goods」、「カラーミー」、「BASE」、「MakeShop」、「ショップサーブ」のいずれかです。
    • 在庫の変更先として「ネクストエンジン」を選択します。
    • 受注情報取り込み用アドレスを入力します。
      受注情報取り込み用アドレスはネクストエンジンの管理画面から設定→基本→店舗とメニューをたどり店舗設定画面を表示し、「編集する店舗を選択」欄で該当する店舗を選択すると確認できます。
      ネクストエンジン「店舗設定画面」
    • ネクストエンジンに受注情報を送る際に使用する商品コードのフォーマットを指定します。
      設定 説明 事例
      商品コード

      オプションコード
      「商品コード」と「オプションコード」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BOOTS001RED_25cm
      トラッキング変数

      オプションコード
      「トラッキング変数」と「オプションコード」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BT01RED_25cm
      商品コード

      副トラッキング変数
      「商品コード」と「副トラッキング変数」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BOOTS001R25
      トラッキング変数

      副トラッキング変数
      「トラッキング変数」と「副トラッキング変数」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BT01R25

      送信される商品コード(上の表の「BOOTS001RED_25cm」あるいは「BOOTS001_R_25」)が、ネクストエンジンに登録された商品データの商品コードと一致している必要があります。 一致しない場合は、正しく処理が行われませんのでご注意ください。

    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると、登録完了画面に遷移します。

  3. 登録完了画面が表示されます。

    登録完了画面

    これで登録は完了です。

9.zaiko Robotを使用する

zaiko Robotを利用して在庫を管理することが可能です。

zaiko Robotを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先を選択します。指定できるのは、「J-goods」、「カラーミー」、「BASE」、「MakeShop」、「ショップサーブ」のいずれかです。
    • 在庫の変更先として「zaiko Robot」を選択します。
    • 受信メールユーザ名を入力します。
      受信メールユーザ名はzaiko Robotの管理画面から管理者情報メニューをクリックすることで表示される管理者情報画面で確認できます。
      zaiko Robotの「管理者情報画面」
    • ショップ名を入力します。
      ショップ名はzaiko Robotの管理画面から管理者情報メニューをクリックすることで表示される管理者情報画面で確認できます。
      なおzaiko Roboto側でJ-goodsから送信された受注メールを受信するには、送信先の店舗が「連動ON」になっている必要があります。 もし該当店舗が「連動OFF」になっている場合は、zaiko Robotに依頼して「連動ON」に設定してもらう必要があります。
    • zaiko Robotに受注情報を送る際に使用する商品コードのフォーマットを指定します。
      設定 説明 事例
      商品コード

      オプションコード
      「商品コード」と「オプションコード」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BOOTS001RED_25cm
      トラッキング変数

      オプションコード
      「トラッキング変数」と「オプションコード」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BT01RED_25cm
      商品コード

      副トラッキング変数
      「商品コード」と「副トラッキング変数」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BOOTS001R25
      トラッキング変数

      副トラッキング変数
      「トラッキング変数」と「副トラッキング変数」を連結したものをネクストエンジンに受注情報を送る際の商品コードとして使用します。
      商品コード BOOTS001
      オプションコード RED_25cm
      トラッキング変数 BT01
      副トラッキング変数 R25
      送信時の商品コード BT01R25

      送信される商品コード(上の表の「BOOTS001RED_25cm」あるいは「BOOTS001_R_25」)が、zaiko Robotに登録された商品データの商品コードと一致している必要があります。 一致しない場合は、正しく処理が行われませんのでご注意ください。

    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると、登録完了画面に遷移します。

  3. 登録完了画面が表示されます。

    登録完了画面

    これで登録は完了です。

10.独自APIを使用する

独自APIを利用することで、通販業者様の基幹システムに受注情報を取り込んで管理することができます。
なお独自APIを利用するには、通販業者様側でプログラムを設置していただく必要があります。詳しくは「J-goodsから送信されたデータを受け取るプログラム」をご覧ください。

独自APIを利用する場合は次のように設定します。

  1. 他社API連携設定画面を開き、必要な情報を入力します。

    他社API連携設定画面
    • 商品情報の取得先を選択します。指定できるのは、「J-goods」、「カラーミー」、「BASE」「MakeShop」のいずれかです。
    • 在庫の変更先として「独自API」を選択します。
    • 他の項目を設定します。 各項目の設定内容は以下のとおりです。
      入力項目 必須 説明
      URL 通販業者様が設置されたプログラムの URL を指定します。
      ポート指定   上で指定した URL のポートを必要に応じて指定します。
      パラメータ   追加で送出したいパラメータがある場合に指定します。ここで指定したパラメータが常に付加されます。
      指定する際には「パラメータ名=値」という形で指定してください。
      例:key1=value1&key2=value2
      ユーザー・エージェントの送出   設置したプログラムがユーザー・エージェントをチェックしている場合に設定してください。
      ユーザー名   BASIC 認証用です。設置したプログラムにアクセスする際、BASIC認証が必要となる場合にユーザー名を指定します。BASIC認証を使用しないのであれば、入力する必要はありません。
      パスワード   BASIC 認証用です。設置したプログラムにアクセスする際、BASIC認証が必要となる場合にパスワードを指定します。BASIC認証を使用しないのであれば、入力する必要はありません。
      パスワード(確認)   BASIC 認証用パスワードの確認です。上と同じパスワードを入力してください。
      データ送信イベント   データを送信するイベントを選択します。基幹システムにデータを送信させたいイベントを選択してください。各イベントが発生するタイミングは以下のとおりです。
      1. ステータスが注文取消に変わる処理が実行された時
        注文を取り消す処理が行われた場合に送信されます。(図の
      2. ステータスが注文受付に変わる処理が実行された時
        お客様が注文を確定し、ステータスが注文受付に変わった場合に送信されます。(図の
      3. ステータスが決済待ちに変わる処理が実行された際
        お客様に請求する決済金額が確定し、ステータスが決済待ちに変わった場合に送信されます。(図の
      4. ステータスが承認待ちに変わる処理が実行された際
        お客様の決済が完了する、あるいは返答待ちで注文継続を選択するなど、ステータスが承認待ちに変わった場合に送信されます。(図の
      5. ステータスが返答待ちに変化する処理が実行された際
        数量の変更を伴う注文修正などでステータスが返答待ちに変わった場合に送信されます。(図の
      6. ステータスが変化しない注文修正処理が実行された際
        数量の変更を伴わない注文修正を行った場合に送信されます。
      7. ステータスが発送待ちに変わる処理が実行された際
        ステータスが発送待ちに変わった場合に送信されます。(図の
      8. ステータスが発送済みに変わる処理が実行された際
        発送通知を行い、ステータスが発送済みに変わった場合に送信されます。(図の
      9. ステータスが変化せず発送情報の更新のみが実行された際
        トラッキング番号などの発送情報が変更された場合に送信されます。
      10. ステータスが入荷待ちに変わる処理が実行された際
        商品が入荷待ちのため、ステータスを入荷待ちに変更した場合に送信されます。(図の
      11. ステータスが出荷後取消になる処理が実行された際
        出荷後にキャンセルされたため、ステータスが出荷後取消に変更された場合に送信されます。(図の
      12. ステータスが注文分割に変わる処理が実行された際
        複数の商品を含む注文が二つの注文に分割され、ステータスが注文分割に変更された場合に送信されます。(図の
      13. ステータスが再決済待ちに変わる処理が実行された際
        お客様の決済の承認に失敗した場合など、ステータスが再決済待ちに変更された場合に送信されます。(図の
      14. ステータスが振込確認待ちに変わる処理が実行された際
        お客様が支払方法として為替送金を選択され、ステータスが振込確認待ちに変更された場合に送信されます。(図の
      15. 日本郵便書類作成機能を利用して書類作成が成功した時
        書類を作成するたびに送信されます。

      各イベントの発生タイミングについては下記の図をご覧ください。図が煩雑になるためステータスが変化しない一部のイベントは省略していますので、その点はご了承ください。

      J-goodsパスワード J-goods のパスワードを入力してください。
    • J-goods用パスワードを入力して、確認ボタンをクリックします。
  2. 確認画面が表示されます。必要があれば前の画面に戻って、再度設定し直してください。

    他社API連携確認画面

    送信ボタンをクリックすると、登録完了画面に遷移します。

  3. 登録完了画面が表示されます。

    登録完了画面

    これで登録は完了です。

  4. API秘密キーを確認するには、登録後、再度、他社API連携設定画面を表示させてください。設定情報の中に「API秘密キー」が表示されます。

    他社API連携設定画面

    このAPI秘密キーは、受注データを復号する際に使用します。

11.J-goodsから送信されたデータを受け取るプログラム

J-goodsから送信されたデータを受け取るプログラムを作成する際には以下の点にご留意ください。

  • プログラムの流れ

    J-goodsから送信されたデータを受け取る通販業者様プログラムの流れは以下のとおりです。

    1. J-goodsシステムから送られたリクエスト・パラメータを取得

      「order」というパラメータ名でPOST送信されます。

    2. 取得したデータを復号

      取得したデータは暗号化されているのでAPI秘密キーを用いて受注データを復号します。たとえば php を利用した復号用関数は以下のようになります。

      /**
       * 暗号化された文字列を復号します。
      * @param string $encrypted 独自APIから送られてくるencryptパラメータ * @param string $apiSecretKey 独自API利用登録時に発行されたAPI秘密キー * @return string 復号された文字列 */ function decryptText($encrypted, $apiSecretKey) { // 暗号化方式の指定 $method = 'AES-128-CBC'; $encrypted = base64_decode($encrypted); // 初期化ベクトルの取得 $ivLength = openssl_cipher_iv_length($method); $iv = substr($encrypted, 0, $ivLength); // 暗号文を取得 $encrypt = substr($encrypted, $ivLength); // 復号 $plaintext = openssl_decrypt($encrypt, $method, $apiSecretKey, OPENSSL_RAW_DATA, $iv); return $plaintext; }

      復号したデータはJSON形式になっています。

    3. ハッシュのチェック

      JSON形式のデータに含まれているハッシュを取り出します。さらに送られたきたデータからハッシュの情報を削除し、残ったデータのsha256ハッシュを取り込みます。このハッシュと、パラメータとして送られてきたハッシュと比較し、一致すればデータは途中で改ざんされることなく正しく送られていると判断できます。

      // パラメータ名「order」でPOST送信されてきます。
      $postedData = isset($_POST['order']) ? $_POST['order'] : '';
      
      // 送られてきたデータを復号します。
      $data = decryptText($postedData, $apiSecretKey);
      
      // 送られてきたデータはJSON文字列になっています。
      $orderData = json_decode($data, true);
      
      // データの改ざんがないかをチェックします。
      // 送られてきたハッシュを取得します。
      $originalHash = $orderData['hash'];
      
      // 送られたきたデータからハッシュの情報を削除します。
      unset($orderData['hash']);
      // 残ったデータ(注文情報と送信時刻の情報)をJSON文字列に変換し、ハッシュを取得します。
      $hash = hash('sha256', json_encode($orderData));
      
      // 二つのハッシュが一致すれば、改ざんされていないと判断できます。
      // 一致しない場合は改ざんされている可能性があります。
      if ($hash !== $originalHash) {
          // 何らかの処理を行う場合はここに記述します。
          error_log('以下のデータは改ざんされた可能性があります。');
          error_log(print_r($orderData, true));
      }
                                  
    4. レスポンスの返信

      処理が終了したならステータスコードを返します。 正常に処理ができた場合にはステータスコード「200」を返してください。 「200」以外の値が返された場合は、「200」が返されるまで3時間おきに3日間、送信が繰り返されます。

      // レスポンスを返します。
      // 正常に処理ができた場合にはステータスコード「200」を返してください。
      // 「200」以外の値が返された場合は、「200」が返されるまで3時間おきに3日間、送信が繰り返されます。
      http_response_code(200);
                                  

      在庫引当数など受注情報を更新する必要がある場合は、受注情報APIをご利用ください。

  • サンプル

    送られてくる受注情報を処理するサンプルプログラムの一例です。

    // 各自のAPI秘密キーを設定してください。
    // API秘密キーは他社API連携設定のページで確認することができます。「在庫管理」の方法として「独自API」するとAPI秘密キーが表示されます。
    // https://www.j-goods.net/shop/mypage/WebAPI/
    $apiSecretKey = 'api-000017-xxxxxxxx';            // 各自のAPI秘密キー
    
    // パラメータ名「order」でPOST送信されてきます。
    $postedData = isset($_POST['order']) ? $_POST['order'] : '';
    
    // 送られてきたデータを復号します。
    $data = decryptText($postedData, $apiSecretKey);
    
    // 送られてきたデータはJSON文字列になってるのでデコードします。
    $orderData = json_decode($data, true);
    
    // データの改ざんがないかをチェックします。
    // 送られてきたハッシュを取得します。
    $originalHash = $orderData['hash'];
    
    // 送られたきたデータからハッシュの情報を削除します。
    unset($orderData['hash']);
    // 残ったデータ(注文情報と送信時刻の情報)をJSON文字列に変換し、ハッシュを取得します。
    $hash = hash('sha256', json_encode($orderData));
    
    // 二つのハッシュが一致すれば、改ざんされていないと判断できます。
    // 一致しない場合は改ざんされている可能性があります。
    if ($hash !== $originalHash) {
        // 何らかの処理を行う場合はここに記述します。
        error_log('以下のデータはデータが改ざんされた可能性があります。');
        error_log(print_r($orderData, true));
    }
    
    // 受注情報を取り出します。取得できる情報は受注情報APIで取得できる情報と同じです。
    $order = $orderData['order'];
    
    // 取り出した受注情報を用いて必要に応じた処理を行ってください。
    // 必要な処理を記述。
    //error_log(print_r($orderData, true));
    
    // レスポンスを返します。
    // 正常に処理ができた場合にはステータスコード「200」を返してください。
    // 「200」以外の値が返された場合は、「200」が返されるまで3時間おきに3日間、送信が繰り返されます。
    http_response_code(200);
    
    return;
    
    /**
     * @param null $newcode
     * @return int|null
     */
    
    if (!function_exists('http_response_code')) {
        function http_response_code($newcode = NULL)
        {
            static $code = 200;
            if ($newcode !== NULL) {
                header('X-PHP-Response-Code: ' . $newcode, true, $newcode);
                if (!headers_sent()) {
                    $code = $newcode;
                }
            }
            return $code;
        }
    }
    
    /**
     * 暗号化された文字列を復号します。
    * @param string $encrypted 独自APIから送られてくるencryptパラメータ * @param string $apiSecretKey 独自API利用登録時に発行されたAPI秘密キー * @return string 復号された文字列 */ function decryptText($encrypted, $apiSecretKey) { // 暗号化方式の指定 $method = 'AES-128-CBC'; $encrypted = base64_decode($encrypted); // 初期化ベクトルの取得 $ivLength = openssl_cipher_iv_length($method); $iv = substr($encrypted, 0, $ivLength); // 暗号文を取得 $encrypt = substr($encrypted, $ivLength); // 復号 $plaintext = openssl_decrypt($encrypt, $method, $apiSecretKey, OPENSSL_RAW_DATA, $iv); return $plaintext; }
  • 送信パラメータ一覧

    J-goodsシステムから送信されるパラメータは以下のとおりです。

    パラメータ 説明 備考
    order 注文情報 JSON形式 送られてくるパラメータについては「受注情報のレスポンス」を参照
    hash ハッシュ 文字列 JSON形式の注文情報のSHA256ハッシュ