easyPoints

# セットアップ

# API アクセス

まず最初に、プレミアム機能のEasyPoints APIにアクセス出来ることを確認して下さい。現在のサブスクリプションにAPIアクセスが含まれていない場合は（プランによっては含まれています）アプリの設定項目にてプレミアム機能をご購入頂く事が可能です。

  1. 設定画面でアプリご利用プランの「変更」をクリックする API Subscription Section

  2. API仕様の項目をチェックするかプレミアム機能が含まれているプランにアップグレードする API Usage Premium Feature

# API 資格情報

# 認証

EasyPointsプレミアム機能がサブスクリプションに含まれた後、API資格情報の作成項目がアプリの設定画面に表示されます。

API Credentials Section

# Basic (ベーシック) 認証

資格情報が設定画面で見つかる限りEasyPoints APIはBasic 認証を使用します。

Basic 認証 (opens new window)に基づき、EasyPoints APIにリクエストを送る際には必ずHTTPSを使用します。

セキュリティの為にもURLの資格情報はAuthorizationをヘッダーに使用することを強くお勧めします。詳しい情報はこちら (opens new window)へ。

# 事例

以下は、JavaScriptでのBasic認証の使用例です：

WARNING

API資格情報をクライエント側のアプリケーションに直接含まないで下さい。これらは、サーバー側アプリケーションの機密構成など、適切な権限を持つユーザーのみがアクセスできる場所に保管する必要があります。

const authValue = btoa(`${apiPublicKey}:${apiSecretKey}`);

fetch(url, {
    headers: {
      'Content-Type': 'application/json'
      'Authorization': `Basic ${authValue}`,
    }
  });

# 認証

現在、全ての利用可能なAPI資格情報は、マーチャントのEasyPointsアプリに対しての完全権限を持っています。これらには、次の特権が含まれます：

権限 説明
read_point_balances 顧客のポイント数を読み込む
write_point_balances 顧客のポイント数の更新（ポイントの割り当て、等）
read_point_history ポイント履歴の読み込み（注文のポイント情報、等）

# セキュリティ

WARNING

EasyPoints APIの使用にはリスクを伴うことをご承知ください。API資格情報は必ず安全でプライベートな場所に保管することにより、悪意のある当事者によるポイントの配付、撤廃、顧客情報へのアクセス等の回避になります。

慎重にご利用ください：顧客に大量のポイントを配付されたり撤廃されると売り上げやショッピング体験に悪影響が及びます。

# API 資格情報の削除

もし、API 資格情報が漏洩したり、その他の理由も含め、API 資格情報の消去を行いたい場合、EasyPointsアプリの設定画面にて可能です。その直後に新しい資格情報を作成することも可能です。

Delete Credentials

ポイント数 →