はじめに

Yappli CRM Open APIでは、Yappli CRM内の顧客情報の取得をはじめ、登録・更新など、Yappli CRMの様々な機能を使うことができます。
今後もご利用いただける機能を拡張してまいります。

API利用の申し込み

Yappli CRM Open APIをご利用いただく際は、Yappli-CRMのご契約が必要です。
ご契約の際、Yappli CRM Open API利用の旨、ならびにAPIへアクセスするサーバーの"IPアドレス"を、弊社営業までご連絡ください。

その後、弊社からは以下をご連絡いたします。
・client_id　（後述の"認証"で利用します）
・client_secret　（後述の"認証"で利用します）
・Yappli CRMのログインアカウント

リクエスト

Yappli CRM Open API へのリクエストの文字エンコーディングはUTF-8のみに対応しています。

レスポンス

Yappli CRM Open API のレスポンスはJSONオブジェクトを返しています。 文字エンコーディングはUTF-8です。

認証

Yappli CRM API は、OAuth 2.0のクライアント・クレデンシャルズフローの仕様に準拠しています。
RFC 6749, 4.4. [Client Credentials Grant]で定義されているフローとなります。
トークンエンドポイントにトークンリクエストを投げ、応答としてアクセストークンを受け取るフローです。
このフローでは、クライアントアプリケーションの認証のみがおこなわれます。

アクセストークンの取得

弊社から送付されたclient_id、及びログイン情報を使用し、アクセストークンを取得してください。有効期間が過ぎた場合、再度アクセストークンを取得してください。

リクエスト

POST {{APP_URL}}/api/ext/token
              

アクセストークンの作成

# Example Request

curl -X POST "{{APP_URL}}/api/ext/token" \
     -d grant_type=client_credentials \
     -d client_id={client_id} \
     -d client_secret={client_secret}

# Example Response

{
  "access_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "token_type": "bearer",
  "refresh_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "expires_in": 86400,
  "scope": null
}
              

API の利用にはアクセストークンが必要です。 Example Requestを参考にアクセストークンの作成を行なってください。

パラメータ (* 必須)

レスポンス（成功時）

レスポンス（失敗時）

アクセストークンの再発行

アクセストークンの有効期間は発行から1日間です。期限が過ぎると、そのアクセストークンではAPIを利用することができなくなります。その場合は、再度アクセストークンの取得を行ってください。

顧客

顧客一覧

登録されている顧客の一覧を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

リクエスト

GET {{APP_URL}}/api/ext/users
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

顧客詳細

登録されている顧客の詳細情報を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

リクエスト

GET {{APP_URL}}/api/ext/users/{id}
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

顧客詳細（ユニークID）

登録されている顧客の詳細情報をユニークIDで取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

リクエスト

GET {{APP_URL}}/api/ext/users/unique_id/{unique_id}
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

顧客登録

新規顧客情報を登録します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

リクエスト

POST {{APP_URL}}/api/ext/users
              

# Example Request

curl -X POST "{APP_URL}/api/ext/users" \
     -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -F login_id=taro@crm.yapp.li \
     -F password=pass1234 \
     -F rank=5 \
     -F column01='ヤプリ太郎' \
     -F colmun02='2000-12-31'
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

顧客更新

登録されている顧客の情報を更新します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

PUT {{APP_URL}}/api/ext/users/{id}
              

# Example Request

curl -X PUT "{APP_URL}/api/ext/users/{id}" \
     -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -F login_id=taro@crm.yapp.li \
     -F password=pass1234 \
     -F rank=5 \
     -F column01='ヤプリ太郎' \
     -F colmun02='2000-12-31'
              

パラメータ (* 必須)

HTTP STATUS CODE: 200

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

ポイント

ポイント付与履歴

顧客に対して付与したポイントの履歴を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET {{APP_URL}}/api/ext/users/{id}/points
              

# Example Request

curl -X GET "{APP_URL}/api/ext/users/{id}/points" \
     -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

ポイント付与（加算・減算）

ポイントの付与（加算・減算）を行います。
プラス値は加算、マイナス値は減算になります。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST {{APP_URL}}/api/ext/users/{id}/points
              

# Example Request

curl -X POST "{APP_URL}/api/ext/users/{id}/points" \
     -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -F point=100 \
     -F title='キャンペーンポイント10pt,' \
     -F remarks='備考欄'
              

パラメータ (* 必須)

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）

サービス間のログインユーザーの引き継ぎ

Yappli-CRMと他サービス間でログインユーザーの情報を引き継ぐために発行されたトークンをチェックします。
成功すると、ログインユーザーの顧客情報を返却します。

引き継ぎトークンチェック

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET {{APP_URL}}/api/ext/check/{token}?id={id}
              

# Example Request

curl -X GET "{APP_URL}/api/ext/check/{token}?id={id}" \
     -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 
              

パラメータ (* 必須)

HTTP STATUS CODE: 200

レスポンス（成功時）

HTTP STATUS CODE: 200

レスポンス（失敗時）