サービス間でログイン状態を引き継ぐための検証APIです。全体の流れは SSO / ログイン状態の引き継ぎガイド を参照してください。
引き継ぎトークンチェック
GET/api/ext/check/{token}
認証:Authorization: Bearer {access_token} が必要
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token |
String | ○ | 「遷移先へのパラメータ引き継ぎ」機能によって自動付与されるトークン |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
id |
String | ○ | 引き継ぎ対象の顧客ID(明示的にパラメータへ付与する必要があります) |
リクエスト例
curl -X GET "{{APP_URL}}/api/ext/check/{token}?id={id}" \
-H "Authorization: Bearer {access_token}"
レスポンス(成功時)
HTTPステータス:200
{
"status": true
}
| フィールド | 型 | 説明 |
|---|---|---|
status |
Boolean | 指定した id のユーザーがYappliCRMにログイン状態であれば true |
レスポンスには顧客情報(氏名・連絡先等)は含まれません。ログイン状態の真偽のみを返却します。
レスポンス(失敗時)
HTTPステータス:400
トークンが期限切れの場合:
{
"status": false,
"errors": "Token is expired"
}
存在しない・使用済み・id が一致しないなど、その他の不正な token を指定した場合:
{
"status": false,
"errors": "Invalid Token"
}
なお、本APIはトークンを一度検証すると無効になるワンタイム方式のため、検証に成功したトークンで再度呼び出した場合も Invalid Token が返却されます。