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://he.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://he.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://he.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://he.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://he.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://he.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"
    }
}
תיעוד נקודת קצה קריא למכונה