アクセストークン アクセストークン

アクセストークン

最終更新日:

アクセストークンの取得 | Obtaining an access token

デジタルヒューマンとの会話セッションを開始するには、アプリケーションはまず、ウェブサイトとuneeq-js SDKがUneeQプラットフォームを認証するために使用する1回限りのアクセストークンを取得する必要があります。

アプリ例 | Example App

UneeQ API サーバーによって生成された単一の使用トークンを返す Node アプリケーションの例をチェックしてみましょう。

カスタマーJWT トークン | Customer JWT token

1回限りの利用トークンを取得するためのプロセスでは、JWT暗号化(クライアント側)とJWT復号化(UneeQサーバ側)が必要になります。これを実現するためには、共有の JWT 秘密を双方が保有している必要があります。この JWT 秘密は、UneeQ Creator の開発者エリアから取得できます。それ以外の場合は、カスタマーサクセスチームがこのトークンを提供します。クライアントが独自に提供することはできません。

UneeQ Creator の開発者エリア | UneeQ Creator Developers page

リクエスト仕様 | Request specification

アクセストークンを取得するには、以下のリクエストフォーマットを使用して、/api/v1/clients/access/tokensにPOSTリクエストを送信します。

リクエストヘッダ | Request Headers

Key Value
Content-Type application/jwt
workspace workspaceId は、会話を開始したい Persona を識別する ID です。
PersonaId は、UneeQ Creator の Personas エリアで確認できます。それ以外の場合は、カスタマー サクセス チームがこの ID を提供します。
/* NodeJS Example */
headers:{
"content-type":"application/jwt",
"workspace": YourPersonaId
}

リクエストボディ | Request Body

このペイロードは、顧客の JWT トークンを使用して暗号化する必要があります。

Field Type Description
sid String あなたが定義した値で、あなた自身のプラットフォームでこの会話セッションを識別するのに役立ちます。空文字列にすることもできます。
fm-custom-data String オプションです。プラットフォームからの後続のリクエストで送信するアドホックな値を指定します。文字列化された JSON である必要があります。
fm-workspace String workspaceId は、会話を開始したい Persona を識別する ID です。
PersonaId は、UneeQ Creator の Personas エリアで確認できます。それ以外の場合は、カスタマー サクセス チームがこの ID を提供します。
/* NodeJS サンプル */
jwt.sign( /* ボディにはJWTとしてサインし、シークレットにしておく必要があります。*/
{
sid: 'SESSION-ID',
'fm-workspace': YourPersonaId,
'fm-custom-data': JSON.stringify(customData)
},
uneeqSecret
)

(原文)
/* NodeJS Example */
jwt.sign( /* The body must be signed as JWT with customers secret */
{
sid: 'SESSION-ID',
'fm-workspace': YourPersonaId,
'fm-custom-data': JSON.stringify(customData)
},
uneeqSecret
)

応答フォーマット指定 | Response format specification

レスポンスは、コンテンツタイプがapplication/jsonのJSONになります。

Code Status Response
200 OK { "token": SINGLE_USE_TOKEN }
400 Bad Request { "error": ERROR_DESCRIPTION }
401 Unauthorized { "error": ERROR_DESCRIPTION }
403 Forbidden { "error": ERROR_DESCRIPTION }
500 Server Error { "error": ERROR_DESCRIPTION }

トークンの値は uneeq-js SDK がデジタルヒューマンとの会話セッションをインスタンス化するために使用することができます。