JinbaでNetseaの商品と注文を同期する方法

概要

• JinbaのNetseaツールは、カタログの読み取り専用コネクターです。NETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESは仕入先とカテゴリーのデータを返しますが、注文の作成や発注依頼の送信は行いません。
• 認証にはNetseaの買い手向けAPIキーを一つ使い、{{secrets.NETSEA_API_TOKEN}}として保存することで、実行時に平文で露出しないようにします。
• NETSEA_GET_SUPPLIERSは入力パラメーターが不要で、NETSEA_GET_CATEGORIESではall_levels: falseを指定すると最上位のカテゴリー、trueを指定すると入れ子になった全階層を取得できます。
• 取得した結果をGoogle Sheetsや通知に渡し、最新の仕入先やカテゴリーを参照できる状態にしてから、複雑な振り分け処理を追加します。
• 独自のスクリプトを書かずにYAML形式のワークフローを構築できるのが、Jinba Flowです。シークレットと動作が一意に定まる実行はプラットフォームが扱います。

ワークフローにNetseaの仕入先やカテゴリーのデータを取り込むには、JinbaのツールであるNETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESを使います。両ツールは共通のNETSEA_API_TOKENで認証します。データを取得し、Google Sheetsや通知サービスなどの出力先へ渡すと、ワークフローが完成します。

これら二つのツールが扱うのはカタログデータのみです。Jinbaは現在、Netsea Buyer APIを使う注文の作成や送信の操作をドキュメントに示していません。ここで扱うのは仕入先とカテゴリーの読み取りであり、Netseaの自動化を始める際の適切な第一歩です。

まずNetseaのAPIトークンを取得する

認証は、連携を始めるための主要な前提条件です。Netsea Buyer APIでは、リクエストごとに買い手向けAPIキーが必要です。Jinbaでは、このキーをNETSEA_API_TOKENとして参照します。

生成手順は次のとおりです。

1. 買い手のアカウントを作成するか、ログインするサイトはnetsea.jpです。
2. アカウント設定を開き、新しい買い手向けAPIキーを生成します。
3. キーをコピーし、Jinbaのシークレットとして保存します。参照には{{secrets.NETSEA_API_TOKEN}}を使います。

キーの扱いについて、Netsea Buyer APIのドキュメントは秘密情報として管理すべきことを明記しています。公開リポジトリにコミットしたり、クライアント側の環境に露出させたりしないでください。Jinbaのシークレットに保存すると、ワークフローの定義に平文で記載せず、実行時に渡すことができます。

トークンを用意すると、以降のJinbaのNetseaツール呼び出しは同じ設定ブロックを使います。処理ごとに認証を設定し直す必要はありません。

Jinbaでワークフローを構築する

Jinbaのワークフローは、YAMLで定義する一連の処理です。各処理にはid、tool、シークレットやパラメーターを設定するconfigブロック、前の処理から渡されたデータを格納するinput配列があります。Netseaツールもこの構成に従います。

すべての仕入先を取得する

NETSEA_GET_SUPPLIERSはNetseaで利用できる仕入先の全一覧を取得します。認証トークン以外の入力パラメーターが不要で、Netseaを自動化するワークフローを最も簡単に始められる処理です。

- id: get_suppliers
tool: NETSEA_GET_SUPPLIERS
config:
- name: token
value: "{{secrets.NETSEA_API_TOKEN}}"
input: []

この処理の名前を指定するidフィールドにより、後続の処理から出力を参照できます。configブロックにはJinbaのシークレット参照でトークンを渡します。空のinput配列は、前の処理から入力を受けるのではなく、Netsea APIから直接取得することを示します。

出力は、構造化された仕入先の一覧です。ワークフロー内の後続の処理で利用できます。

商品カテゴリーを取得する

NETSEA_GET_CATEGORIESはNetseaの商品カテゴリー構成を取得します。重要な設定項目はall_levelsです。

設定する項目はall_levelsです。値をfalseにすると最上位のカテゴリーのみ、trueにすると、各階層のサブカテゴリーを含む入れ子になった全階層を返します。多くのカタログの対応付けや振り分けの用途では、trueの方が全体を把握できます。カテゴリー構成が大きく、最上位のみの振り分けが必要な場合は、falseから始めます。

- id: get_categories
tool: NETSEA_GET_CATEGORIES
config:
- name: token
value: "{{secrets.NETSEA_API_TOKEN}}"
- name: all_levels
value: false
input: []

入力の扱いはNETSEA_GET_SUPPLIERSと同じです。input配列が空なのはAPIから直接読み取るためです。configブロックに、トークンとall_levelsの両方の設定を含めます。大まかな分類ではなく、入れ子になったカテゴリーの経路で商品を絞り込んだり振り分けたりする場合は、値をtrueに切り替えます。

同じワークフロー内で、両処理を独立して実行することも、順番に実行することもできます。後続の処理で仕入先とカテゴリーのデータを結合する場合は、まず両方を取得してから、その出力をまとめて情報補完の処理に渡します。

取得データを後続の処理に渡す

仕入先とカテゴリーの取得は、有用なワークフローの前半です。後半では、そのデータを役立つ場所へ渡します。JinbaのNetseaドキュメントに示される標準的な後続処理には、次の選択肢があります。

• Google Sheetsへの書き込み：仕入先を一元管理する名簿や、カテゴリーの参照表を作成します。同じワークフロー内の後続処理で、NETSEA_GET_SUPPLIERSの構造化された出力を指定したシートに直接書き込めます。購買チームは手動でデータを出力せず、随時更新される情報を参照できます。
• 通知の送信：仕入先一覧が変わったときにSlackのメッセージやメールを送ります。最初に導入する自動化は、ロジックが単純で、失敗時の状態が分かるものにすると確実です。
• 商品検索ワークフローへの入力：NETSEA_GET_CATEGORIESが返すカテゴリーIDを、特定の仕入先の特定カテゴリー内の商品を検索する後続処理の条件に使います。

ここでは段階的な構築が有効です。仕入先データをシートに書き込み、完了時に通知するワークフローは、それだけで完成した検証可能な単位になります。社内の分類体系とカテゴリーを照合するなどの複雑な振り分けは、取得と書き込みの基本動作を確認した後に、別の処理として追加できます。

これらのツールが対応していないこと

JinbaのNetseaツールは、カタログデータの読み取り操作に限られます。NETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESは、注文の発行、発注依頼の送信、注文管理のエンドポイントへの操作を行いません。

利用可能な買い手向けエンドポイントの全範囲は、Netsea Buyer APIのドキュメントに記載されています。注文の送信は、現在Jinbaが提供する連携機能の範囲には含まれません。Netseaの仕入先への発注を自動化したい企業は、Buyer APIのドキュメントを直接確認し、その処理に独自の連携が適しているかを検討してください。

この制限が導入を妨げる必要はありません。カタログデータの同期は、Netseaの自動化を始める際の適切な基盤です。利用可能な仕入先や商品カテゴリーを、信頼できる構造化された形で把握することが、商品の調達判断、社内承認、在庫計画の前提になります。まずその基盤を作ることで、元のカタログ情報が正確かつ参照可能になる前に、注文の処理を自動化してしまう事態を避けられます。

次の手順

ワークフロー全体は次の四つの手順です。

1. 買い手向けAPIキーを生成するサイトはnetsea.jpです。取得したキーを、{{secrets.NETSEA_API_TOKEN}}としてJinbaに保存します。
2. 追加するのは、NETSEA_GET_SUPPLIERSの処理です。入力パラメーターを指定せず、仕入先一覧を取得します。
3. 次にNETSEA_GET_CATEGORIESの処理を追加し、カテゴリーの全階層が必要かどうかに応じてall_levelsを設定します。
4. 出力をGoogle Sheetsへの書き込み処理、通知処理、またはその両方に接続します。

日本の企業間電子商取引市場で活動する組織は、このワークフローを一度の構築作業で導入できます。独自のスクリプトは不要で、共通のNETSEA_API_TOKEN以外に追加の認証設定も必要ありません。

ワークフローの構築を始めるには、Jinbaにアクセスしてください。利用可能なツールと設定項目の全一覧は、Jinbaのドキュメントで確認できます。

よくある質問

Jinba用のNetsea APIトークンを取得するには？

買い手のアカウントを作成するか、ログインするサイトはnetsea.jpです。アカウント設定を開き、新しい買い手向けAPIキーを生成します。コピーしたキーをJinbaのシークレットとして保存し、参照には{{secrets.NETSEA_API_TOKEN}}を使います。トークンはすべてのNETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESの処理に必要で、シークレットとして保存すれば平文で露出しません。

JinbaのNetsea連携では実際に何ができますか？

JinbaのツールであるNETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESは、Netsea Buyer APIからカタログデータを読み取ります。仕入先や商品カテゴリーの構造化された一覧を返し、Google Sheets、通知、その他の後続処理に渡せます。現行の連携機能は、注文の作成や発注依頼の送信には対応していません。

JinbaでNetseaへの発注を自動化できますか？

できません。現在のJinbaのNetseaツールは、Buyer APIを使う注文の作成や送信に対応していません。ドキュメントにある二つのツールは、仕入先とカテゴリーの読み取りのみを扱います。発注を自動化したい組織は、Netsea Buyer APIのドキュメントを確認し、その処理の独自連携を計画する必要があります。

Netseaの仕入先をGoogle Sheetsに出力するには？

追加するのは、NETSEA_GET_SUPPLIERSの処理です。NETSEA_API_TOKENを設定し、入力パラメーターは指定しません。その出力を同じワークフローのGoogle Sheetsへの書き込み処理に接続します。手動でデータを出力せず、随時更新される仕入先名簿を作成できます。シートの更新をチームに知らせる通知処理も追加できます。

設定項目のall_levelsは、NETSEA_GET_CATEGORIESで何を指定しますか？

all_levelsは、NETSEA_GET_CATEGORIESが返すカテゴリー構成の深さを指定します。falseなら最上位のカテゴリーのみ、trueなら各階層のサブカテゴリーを含む入れ子になった全階層を取得します。カタログの対応付けや振り分けにはtrueを使います。最上位のみの振り分けが必要なら、falseから始めると返されるデータ量を抑えられます。

JinbaでNetseaのワークフローを作るにはコーディングが必要ですか？

独自のスクリプトは必要ありません。JinbaのワークフローはYAMLで定義した一連の処理で、id、tool、configブロック、input配列で構成されます。Netseaの仕入先とカテゴリーを取得するワークフローは、ドキュメントのYAMLをコピーし、シークレットへの参照を更新して構築できます。

同じワークフローでNETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESを実行できますか？

はい。同じワークフロー内で、両ツールを独立して実行することも、順番に実行することもできます。後続の処理で仕入先とカテゴリーの両データが必要なら、まず両方を取得し、その出力をまとめて情報補完の処理に渡します。それぞれNetsea APIから直接読み取るため、一方の入力にもう一方の出力を使う必要はありません。

Netsea Buyer APIとJinbaのツールのドキュメントはどこにありますか？

Netsea Buyer APIのドキュメントは、api.netsea.jp/docs/buyer/で確認できます。JinbaのNETSEA_GET_SUPPLIERSとNETSEA_GET_CATEGORIESの専用ドキュメントは、carnot.mintlify.app/ja/pages/tools/productivity/netseaにあります。