Zendesk Chatとの統合
どのように動作するか
Zendesk Chatとの統合により、エクソーラログイン製品のユーザーを、サポートチームに質問を提出したZendesk Chatの訪問者とプロジェクトにリンクさせることができます。Zendesk側で使用するexternal_idパラメータは、ログインプロジェクトのユーザIDに対応しています。訪問者をエクソーラログインユーザーとして識別した場合、アドミンページを介してそのアカウントを管理することができます。
使用に適した方
ログインがすでに統合されており、Zendesk Chatアカウントを持っているパートナー。
入手方法
訪問者をリンクするには：
Zendesk JWTを生成する
Zendesk JWTは、ログインプロジェクトでユーザーを認証するときにエクソーラログインサーバーから受信したトークンに基づいています。必要なドメインのクッキーファイルにトークンを保存し、Zendesk JWTの生成時にHTTPリクエストに追加できます。
コールを実装するときに、自分の応答形式を設定することもできます。
以下は、Goに基づいてフローを取得するZendesk JWTの簡易バージョンです。Zendesk JWT生成コード全体はGitHubにあります。
JWTを生成する前に、次のパッケージをインストールします：
- curl
go get github.com/dgrijalva/jwt-go
go get github.com/rs/cors
Zendesk JWTを取得するには：
JWTを検証する
クッキーファイルからJWTを抽出し、アドミンページ>ログインプロジェクト>一般設定>秘密鍵にある秘密鍵で検証します。- go
cookie, err := r.Cookie("token")
token, err := jwt.Parse(cookie.Value, func(token *jwt.Token) (interface{}, error) {
if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, errors.New("unexpected signing method")
}
return []byte(loginSecret), nil
})
var loginClaims jwt.MapClaims
var ok bool
if loginClaims, ok = token.Claims.(jwt.MapClaims); !ok || !token.Valid {
writeErrorResponse(w, "00-01", "Token is invalid", http.StatusUnauthorized)
return
}
JWTをデコードする
JWTをデコードし、JWTから次のクレームの値を抽出します：email-メールアドレスsub-ユーザーID
- go
var sub, email string
sub, _ = loginClaims["sub"].(string)
email, _ = loginClaims["email"].(string)
JWTクレームのリストを作成する
JWTのクレームのリストを作成します。すべてのクレームの説明は、- go
zendeskClaims := jwt.MapClaims{}
zendeskClaims["name"] = email
zendeskClaims["email"] = email
zendeskClaims["external_id"] = sub
zendeskClaims["iat"] = time.Now().UTC().Unix()
JWTを署名する
Zendesk Chatアカウントの秘密鍵でトークンに署名します。- go
zendeskToken := jwt.NewWithClaims(jwt.SigningMethodHS256, zendeskClaims)
zendeskTokenString, _ := zendeskToken.SignedString([]byte(zendeskSecret))
Zendesk Chatへの訪問者の認証
以下の訪問者データをZendesk Chatに追加できます：
- 名前
- メールアドレス
- 識別子
受け取ったZendesk JWTを使用して、訪問者をZendesk Chatに認証します。以下の方法で、
- javascript
zChat.init({
account_key: ACCOUNT_KEY,
authentication: {
jwt_fn: function(callback) {
fetch('https://example.com:8001/generate/token', {
credentials: "include"
}).then(function(res) {
res.text().then(function(body) {
const jwt = JSON.parse(body).token;
callback(jwt)
});
});
}
}
});
訪問者認証フローは、説明とWeb SDKに記載されています。
訪問者との操作
認証に成功すると、Zendesk Chatアカウント>
メソッドの
- 訪問者データを取得する。
- 訪問者がログインプロジェクトにリンクされています。
訪問者データを取得する
http
- http
- curl
GET https://www.zopim.com/api/v2/visitors/9855790-xjj3u5xPWhW1Fv HTTP/1.1
Authorization: Bearer <token>
curl --request GET \
--url https://www.zopim.com/api/v2/visitors/9855790-xjj3u5xPWhW1Fv \
--header 'authorization: bearer_token'
応答の例：
http
- http
- curl
HTTP/1.1 200 OK
Content-Type: application/json
{
"banned": false,
"notes": "",
"id": "9855790.xjj3ukxyIhn6j3",
"email": "email@email.com",
"phone": "",
"created": 1586950554,
"name": "email@email.com",
"external_id": "82cd5e0c-c3ff-11e9-b199-c1e5fc81c37f"
}
{
"banned": false,
"notes": "",
"id": "9855790.xjj3ukxyIhn6j3",
"email": "email@email.com",
"phone": "",
"created": 1586950554,
"name": "email@email.com",
"external_id": "82cd5e0c-c3ff-11e9-b199-c1e5fc81c37f"
}
ログインプロジェクトへの訪問者リンクの確認
訪問者がログインプロジェクトにリンクされている場合、受信データのexternal_idパラメータはユーザーIDに対応します。ユーザーIDは、アドミンページ>ログインプロジェクト>ユーザー>ユーザー名/IDで確認できます。誤字脱字などのテキストエラーを見つけましたか？ テキストを選択し、Ctrl+Enterを押します。
