顧客の識別子(id / unique_id / 外部連携ID)の使い分け

YappliCRMでは、顧客(会員)を識別するための項目として idunique_id・外部連携ID(external_ids)の3種類があります。それぞれ役割が異なるため、設計時に混同しないよう整理します。

id:YappliCRMが管理する顧客ID

id は、YappliCRMのシステム内で顧客ごとに発行される、重複のない顧客IDです。顧客登録時にYappliCRM側で自動的に採番されるため、外部システムから値を指定することはできません。多くのエンドポイント(顧客詳細、ポイント関連API等)では、この id を使って顧客を特定します。

unique_id:外部システムと連携するためのID

unique_id は、外部システム側で管理している重複しない会員ID(会員番号など)をYappliCRMに連携するための項目です。id とは異なり、以下のような特徴があります。

unique_id の自動採番

外部システムから連携せず、YappliCRM側で unique_id を自動的に発行することもできます。発番形式には、連番のほか、NW-7EAN13といったバーコード規格やQRコードでの発番にも対応しています。会員証にバーコードとして表示する運用を想定している場合は、店頭のバーコードリーダーで読み取り可能なNW-7やEAN13を選択するのが一般的です。

発番形式ごとの詳細な設定方法(桁数やチェックデジットの扱い等)については、当社担当者までお問い合わせください。

外部連携ID(external_ids):複数の外部システムとID連携するための項目

外部連携ID(external_ids)は、unique_id とは別に、複数の外部システムがそれぞれ持つ独自のIDをYappliCRMの顧客に紐づけるための項目です。{external_key: external_id} という形式で、1顧客につき最大5件まで登録できます。

unique_id との主な違いは、次の点です。

外部連携IDの値の制約や設定方法の詳細は カスタムフィールド設計ガイド を、顧客の検索方法(external_keyexternal_id を指定した顧客特定)は 顧客詳細(外部連携ID) を参照してください。

まとめ:3つの識別子の使い分け

識別子 発行・管理 主な用途 1顧客あたりの登録数
id YappliCRM側で自動採番(変更不可) 多くのAPIで顧客を一意に特定するための基本ID 1つ
unique_id 外部システムから連携、またはYappliCRM側で自動採番 会員証バーコード等、単一の外部会員IDとの連携 1つ
外部連携ID(external_ids キー名は当社担当者が事前に設定、値はAPI経由で登録 複数の外部システムそれぞれの独自IDをまとめて保持 最大5件(キー単位)