はじめに（クイックスタート）

YappliCRMは、ヤプリが提供するスマートフォンアプリ向けの会員管理（CRM）サービスです。会員（顧客）情報の管理や、ポイント・ランクを使った会員プログラムの運用をアプリ上で実現します。

YappliCRM OpenAPI（以下、本API）を使うと、外部システムからYappliCRMに蓄積された会員情報やポイント情報を取得したり、外部システム側からYappliCRMへ会員の登録・更新をおこなったりできます。YappliCRMをご契約のお客様であれば、本APIに合わせて外部システム側を自由に開発することができます。

このページでは、ご契約から最初のAPIリクエストまでの流れを、ひとつの手順としてまとめています。個別のエンドポイント仕様は各リファレンスページを参照してください。

1. ご利用開始までの流れ

1. お申し込み：YappliCRM OpenAPIのご利用には、YappliCRMのご契約が必要です。ご契約の際、本API利用の旨を弊社営業までご連絡ください。本APIにIPアドレスによる接続制限はないため、アクセス元サーバーのIPアドレスの申告は不要です。
2. 認証情報の受け取り：お申し込み後、弊社より以下の認証情報を発行・ご連絡します。
   • client_id：外部システムを識別するID（後述の「認証」で使用）
   • client_secret：client_id とセットで使う秘密鍵（後述の「認証」で使用）
3. アクセストークンの取得：client_id / client_secret を使って、アクセストークンを取得します（詳細は 認証とトークン管理 を参照）。
4. 最初のAPIリクエスト：取得したアクセストークンを Authorization ヘッダーに付与し、各エンドポイントを呼び出します。

2. 複数システムから接続する場合

1つのSKU（契約単位）に対して複数のシステム・環境から本APIへ接続する場合、接続元ごとに個別の client_secret の発行が必要です。新しい接続元を追加する際は、営業担当までご連絡ください。

3. 通信の基本仕様

本APIと通信する際の、基本的な技術仕様は以下の通りです。

詳細な設計指針は レート制限とリトライ設計 を参照してください。

4. 最初のリクエスト例

実際にAPIを呼び出す例です。以下の例では、①アクセストークンを取得し、②そのトークンを使って顧客一覧を取得しています。

# 1. アクセストークンを取得する
curl -X POST "{{APP_URL}}/api/ext/token" \
  -d grant_type=client_credentials \
  -d client_id={client_id} \
  -d client_secret={client_secret}

# レスポンス例
# {
#   "access_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
#   "token_type": "Bearer",
#   "expires_in": 86400,
#   "scope": null
# }

# 2. 取得したアクセストークンで顧客一覧を取得する
curl -X GET "{{APP_URL}}/api/ext/users" \
  -H "Authorization: Bearer {access_token}"

{{APP_URL}} はご契約環境ごとに払い出されるエンドポイントのホスト名に置き換えてください。

次のステップとして、認証とトークン管理 でトークンの有効期限管理・再取得の設計方針を確認してください。

5. レスポンスの後方互換性について

各リファレンスページのレスポンス凡例に記載のあるフィールドのみがサポート対象です。レスポンスには、凡例に記載のない内部用フィールドが含まれる場合がありますが、これらは予告なく変更・削除されることがあるため参照しないでください。また、フィールドは予告なく追加されることがあるため、外部システム側では未知のフィールドが含まれていても正常に動作するよう実装してください。