お客さまからお問い合わせいただく質問をQ&A形式でまとめました。ここに記載のない内容は、各ガイド・リファレンスページも合わせてご確認ください。
認証・トークン
Q. アクセストークンはAPIリクエストのたびに取得してよいですか?
A. 負荷軽減のため、外部システム側でアクセストークンの有効期限を管理し、期限切れのタイミングで再取得する構成を推奨しています。詳細は 認証とトークン管理 を参照してください。
Q. リフレッシュトークンはありますか?
A. ありません。トークンの更新は client_credentials グラントによる再取得をご利用ください。
Q. アクセストークンの最大文字数は?
A. 固定の文字数はありません。DB等に保存する場合は、余裕を持った長さ(255文字程度を推奨)で設計してください。
レート制限・タイムアウト・通信要件
Q. レート制限はありますか?
A. 各クライアント・各エンドポイントごとに1分間2000リクエスト以下でのご利用を推奨しています。大量データを処理する際は、並列ではなく直列でのAPIコールを推奨します。
Q. レート制限(2000/分)を超えるとどうなりますか?
A. 現状、明示的なエラーは返却されません。ただし将来的に制限が強化される可能性があるため、推奨頻度内でのご利用をお願いします。
Q. タイムアウトはありますか?
A. 60秒です。
Q. IPアドレス制限はありますか?
A. ありません。
Q. 対応しているTLSバージョンは?
A. TLS 1.2以上です。TLS 1.0 / 1.1では接続できません。
顧客一覧・顧客詳細
Q. 顧客一覧のフィルタリング・ソートは可能ですか?
A. できません。per_page / page によるページングのみ対応しています。返却順は、YappliCRM内部の顧客ID昇順(登録日時の古い順)で固定です。
Q. 顧客一覧APIでカスタムフィールドを物理名(キー名)で取得できますか?
A. 顧客一覧APIではできません(常に column01〜column50 の連番キーで返却されます)。顧客詳細系のAPIでは with_column_key パラメータで物理名指定が可能です。詳細は カスタムフィールド設計 を参照してください。
Q. 顧客詳細/顧客詳細(ユニークID)/顧客詳細(外部連携ID)の使い分けは?
A.
- 顧客詳細:YappliCRMの顧客IDが外部システム側で特定できている場合
- 顧客詳細(ユニークID):会員証の読み取り等によりユニークIDが特定できている場合
- 顧客詳細(外部連携ID):事前に外部連携IDを外部システム側で連携済みの場合
顧客登録・更新
Q. unique_id や login_id はユニークチェックされますか?
A. されます。重複した場合は、それぞれ「指定のunique idは既に使用されています。」「指定のlogin idは既に使用されています。」というエラーメッセージが返却されます。
Q. カスタムフィールドを物理名で登録・取得できますか?
A. with_column_key を true にすることで、レスポンスに物理名のキーが追加されます。
Q. 外部連携ID(external_ids)のキー名は、どこで設定しますか?
A. クライアント側で直接設定することはできません。設定が必要な場合は、営業担当までご連絡ください。登録できるキーは最大5件までです。詳細は カスタムフィールド設計 を参照してください。
ポイント
Q. ポイントは即時反映されますか?
A. 基本的には即時反映されます。
Q. 直前に付与したポイントを取り消す方法は?
A. 専用の取消APIはありません。ポイント付与履歴APIを実行して最新の履歴を確認の上、必要に応じてマイナス値でのポイント付与(減算)をおこなってください。
Q. ランクに設定されているポイント付与率をAPIで取得できますか?
A. できません。
Q. ポイント付与履歴・ポイント有効期限一覧で取得できる情報は、アプリの表示内容と差分がありますか?
A. 基本的には同じです。
サービス間のログイン状態引き継ぎ(SSO)
Q. 引き継ぎの仕組みを教えてください。
A. SSO / ログイン状態の引き継ぎガイド を参照してください。
Q. POSTでパラメータを引き継ぐ場合のContent-Typeは?
A. application/x-www-form-urlencoded です。
その他
Q. ログインAPI・ログアウトAPI・退会APIはありますか?
A. あります。顧客リファレンスのログイン・ログアウト・退会の各エンドポイントをご利用ください。
Q. レスポンスのサンプルデータをもらえますか?
A. 各リファレンスページに記載のレスポンス例をご確認ください。個別のデータについては営業担当までお問い合わせください。