AT AppointmentTrader
サインイン
オンライン中  

/v1/auth/

Auth session management endpoints for native v2 account surfaces. Email-code and Google-state initiation are public by design. Session-management endpoints are authenticated-only. They expose the viewer's active browser sessions, allow a user to remove one session, remove every other session, or remove all sessions. Removing the current browser session clears the current browser session cookie and returns signedOut=true so native v2 clients can hard-navigate into the logged-out shell.
GET

/v1/auth/get_sessions

#
Return the authenticated user's active sessions, with the current browser session marked for display on the native v2 Session Manager.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/auth/get_sessions' \
  --data-urlencode 'key={{API_KEY}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$auth_get_sessions_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.sessionsarray はい
$.oneOf[0].allOf[1].Payload.sessions[]object いいえ
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.sessions[].citystring はい
$.oneOf[0].allOf[1].Payload.sessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.otherSessionsarray はい
$.oneOf[0].allOf[1].Payload.otherSessions[]object いいえ
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger はい
$.oneOf[0].allOf[1].Payload.signedOutboolean はい
$.oneOf[0].allOf[1].Payload.redirectUrlstring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/get_sessions",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/auth/set_all_sessions_removed

#
Remove every active session owned by the authenticated user, including the current browser session. The browser cookie is expired and the response includes signedOut=true.

パラメーター

名前型必須既定値説明
isWritingRequest bool いいえ false Set true to actually remove all sessions.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/auth/set_all_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$auth_set_all_sessions_removed_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.sessionsarray はい
$.oneOf[0].allOf[1].Payload.sessions[]object いいえ
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.sessions[].citystring はい
$.oneOf[0].allOf[1].Payload.sessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.otherSessionsarray はい
$.oneOf[0].allOf[1].Payload.otherSessions[]object いいえ
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger はい
$.oneOf[0].allOf[1].Payload.signedOutboolean はい
$.oneOf[0].allOf[1].Payload.redirectUrlstring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_all_sessions_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/auth/set_google_oauth_state

#
Create signed Google OAuth state, including optional signup-page context. Public-by-design: anonymous users must be able to begin Google authentication.

パラメーター

名前型必須既定値説明
signupContext string いいえ "" Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
isWritingRequest bool いいえ false Set true to issue state and its anti-CSRF cookie.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/auth/set_google_oauth_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'signupContext={{signupContext}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: signupContext
フィールド型必須説明
signupContextstring (application/json) いいえ
signupContextobject (デコードされたJSON) いいえ
signupContext.pathstring はい
signupContext.locationIDDatabaseInteger いいえInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.locationID.oneOf[0]integer いいえ
signupContext.locationID.oneOf[1]string いいえ
signupContext.capturedAtDatabaseInteger いいえInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.capturedAt.oneOf[0]integer いいえ
signupContext.capturedAt.oneOf[1]string いいえ
レスポンスフィールド
フィールド型必須説明
$auth_set_google_oauth_state_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payload はい
$.oneOf[0].allOf[1].Payload.oneOf[0]object はい
$.oneOf[0].allOf[1].Payload.oneOf[0].State = "Success" はい
$.oneOf[0].allOf[1].Payload.oneOf[0].Payloadstring はい
$.oneOf[0].allOf[1].Payload.oneOf[1]object はい
$.oneOf[0].allOf[1].Payload.oneOf[1].State = "Failed" はい
$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessagestring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_google_oauth_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "Payload": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/auth/set_other_sessions_removed

#
Remove every active session except the current browser session. The viewer remains signed in on this device and receives a refreshed list.

パラメーター

名前型必須既定値説明
isWritingRequest bool いいえ false Set true to actually remove other sessions.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/auth/set_other_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$auth_set_other_sessions_removed_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.sessionsarray はい
$.oneOf[0].allOf[1].Payload.sessions[]object いいえ
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.sessions[].citystring はい
$.oneOf[0].allOf[1].Payload.sessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.otherSessionsarray はい
$.oneOf[0].allOf[1].Payload.otherSessions[]object いいえ
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger はい
$.oneOf[0].allOf[1].Payload.signedOutboolean はい
$.oneOf[0].allOf[1].Payload.redirectUrlstring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_other_sessions_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/auth/set_send_login_code

#
Send an email login code using the existing authentication flow. A new account retains optional signup-page context independently from its post-login return destination. Public-by-design: anonymous users must be able to begin email authentication.

パラメーター

名前型必須既定値説明
email string はい — Email address to authenticate.
origin string いいえ "Sign in" Existing auth action label.
originalRequest string いいえ "" Base64-encoded post-login return URL.
signupContext string いいえ "" Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
isWritingRequest bool いいえ false Set true to send the code.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/auth/set_send_login_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'email={{email}}' \
  --data-urlencode 'origin={{origin}}' \
  --data-urlencode 'originalRequest={{originalRequest}}' \
  --data-urlencode 'signupContext={{signupContext}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: signupContext
フィールド型必須説明
signupContextstring (application/json) いいえ
signupContextobject (デコードされたJSON) いいえ
signupContext.pathstring はい
signupContext.locationIDDatabaseInteger いいえInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.locationID.oneOf[0]integer いいえ
signupContext.locationID.oneOf[1]string いいえ
signupContext.capturedAtDatabaseInteger いいえInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.capturedAt.oneOf[0]integer いいえ
signupContext.capturedAt.oneOf[1]string いいえ
レスポンスフィールド
フィールド型必須説明
$auth_set_send_login_code_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payload はい
$.oneOf[0].allOf[1].Payload.oneOf[0]object はい
$.oneOf[0].allOf[1].Payload.oneOf[0].State = "Success" はい
$.oneOf[0].allOf[1].Payload.oneOf[0].URLstring はい
$.oneOf[0].allOf[1].Payload.oneOf[1]object はい
$.oneOf[0].allOf[1].Payload.oneOf[1].State = "Failed" はい
$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessagestring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[2]object はいLegacy authenticate.php exits directly after a checkout email-binding failure, before CallLegacyEndpoint can wrap this JSON.
$.oneOf[2].State = "Failed" はい
$.oneOf[2].ErrorMessagestring はい
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_send_login_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "URL": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/auth/set_session_removed

#
Remove one active session owned by the authenticated user. If that session is the current browser session, the browser cookie is expired and the response includes signedOut=true.

パラメーター

名前型必須既定値説明
sessionID string はい — Session token returned by get_sessions.
isWritingRequest bool いいえ false Set true to actually remove the session.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/auth/set_session_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sessionID={{sessionID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$auth_set_session_removed_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.sessionsarray はい
$.oneOf[0].allOf[1].Payload.sessions[]object いいえ
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.sessions[].citystring はい
$.oneOf[0].allOf[1].Payload.sessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.sessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.otherSessionsarray はい
$.oneOf[0].allOf[1].Payload.otherSessions[]object いいえ
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean はい
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean はい
$.oneOf[0].allOf[1].Payload.currentSessionIDstring はい
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger はい
$.oneOf[0].allOf[1].Payload.signedOutboolean はい
$.oneOf[0].allOf[1].Payload.redirectUrlstring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_session_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}
機械可読のエンドポイントドキュメント