AT AppointmentTrader
Iniciar sesión
En línea ahora  

/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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/auth/get_sessions' \
  --data-urlencode 'key={{API_KEY}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_get_sessions_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.sessionsarray si
$.oneOf[0].allOf[1].Payload.sessions[]object No
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].ipstring si
$.oneOf[0].allOf[1].Payload.sessions[].citystring si
$.oneOf[0].allOf[1].Payload.sessions[].countrystring si
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].agentstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.otherSessionsarray si
$.oneOf[0].allOf[1].Payload.otherSessions[]object No
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger si
$.oneOf[0].allOf[1].Payload.signedOutboolean si
$.oneOf[0].allOf[1].Payload.redirectUrlstring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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"
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
isWritingRequest bool No false Set true to actually remove all sessions.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/auth/set_all_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_set_all_sessions_removed_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.sessionsarray si
$.oneOf[0].allOf[1].Payload.sessions[]object No
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].ipstring si
$.oneOf[0].allOf[1].Payload.sessions[].citystring si
$.oneOf[0].allOf[1].Payload.sessions[].countrystring si
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].agentstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.otherSessionsarray si
$.oneOf[0].allOf[1].Payload.otherSessions[]object No
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger si
$.oneOf[0].allOf[1].Payload.signedOutboolean si
$.oneOf[0].allOf[1].Payload.redirectUrlstring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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"
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
signupContext string No "" Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
isWritingRequest bool No false Set true to issue state and its anti-CSRF cookie.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/auth/set_google_oauth_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'signupContext={{signupContext}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Parámetros: signupContext
CampoTipoObligatorioDescripción
signupContextstring (application/json) No
signupContextobject (JSON decodificado) No
signupContext.pathstring si
signupContext.locationIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.locationID.oneOf[0]integer No
signupContext.locationID.oneOf[1]string No
signupContext.capturedAtDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.capturedAt.oneOf[0]integer No
signupContext.capturedAt.oneOf[1]string No
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_set_google_oauth_state_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payload si
$.oneOf[0].allOf[1].Payload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.oneOf[0].State = "Success" si
$.oneOf[0].allOf[1].Payload.oneOf[0].Payloadstring si
$.oneOf[0].allOf[1].Payload.oneOf[1]object si
$.oneOf[0].allOf[1].Payload.oneOf[1].State = "Failed" si
$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessagestring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_google_oauth_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "Payload": "synthetic-example"
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
isWritingRequest bool No false Set true to actually remove other sessions.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/auth/set_other_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_set_other_sessions_removed_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.sessionsarray si
$.oneOf[0].allOf[1].Payload.sessions[]object No
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].ipstring si
$.oneOf[0].allOf[1].Payload.sessions[].citystring si
$.oneOf[0].allOf[1].Payload.sessions[].countrystring si
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].agentstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.otherSessionsarray si
$.oneOf[0].allOf[1].Payload.otherSessions[]object No
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger si
$.oneOf[0].allOf[1].Payload.signedOutboolean si
$.oneOf[0].allOf[1].Payload.redirectUrlstring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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"
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
email string si — Email address to authenticate.
origin string No "Sign in" Existing auth action label.
originalRequest string No "" Base64-encoded post-login return URL.
signupContext string No "" Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
isWritingRequest bool No false Set true to send the code.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.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}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Parámetros: signupContext
CampoTipoObligatorioDescripción
signupContextstring (application/json) No
signupContextobject (JSON decodificado) No
signupContext.pathstring si
signupContext.locationIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.locationID.oneOf[0]integer No
signupContext.locationID.oneOf[1]string No
signupContext.capturedAtDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
signupContext.capturedAt.oneOf[0]integer No
signupContext.capturedAt.oneOf[1]string No
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_set_send_login_code_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payload si
$.oneOf[0].allOf[1].Payload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.oneOf[0].State = "Success" si
$.oneOf[0].allOf[1].Payload.oneOf[0].URLstring si
$.oneOf[0].allOf[1].Payload.oneOf[1]object si
$.oneOf[0].allOf[1].Payload.oneOf[1].State = "Failed" si
$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessagestring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
$.oneOf[2]object siLegacy authenticate.php exits directly after a checkout email-binding failure, before CallLegacyEndpoint can wrap this JSON.
$.oneOf[2].State = "Failed" si
$.oneOf[2].ErrorMessagestring si
Ejemplo de respuesta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_send_login_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "URL": "synthetic-example"
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
sessionID string si — Session token returned by get_sessions.
isWritingRequest bool No false Set true to actually remove the session.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/auth/set_session_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sessionID={{sessionID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$auth_set_session_removed_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.sessionsarray si
$.oneOf[0].allOf[1].Payload.sessions[]object No
$.oneOf[0].allOf[1].Payload.sessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.sessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].ipstring si
$.oneOf[0].allOf[1].Payload.sessions[].citystring si
$.oneOf[0].allOf[1].Payload.sessions[].countrystring si
$.oneOf[0].allOf[1].Payload.sessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.sessions[].agentstring si
$.oneOf[0].allOf[1].Payload.sessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.sessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.sessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.sessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.sessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionIDstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ipstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].citystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].countrystring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabelstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agentstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOriginstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildModestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientTypestring si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.otherSessionsarray si
$.oneOf[0].allOf[1].Payload.otherSessions[]object No
$.oneOf[0].allOf[1].Payload.otherSessions[].sessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDatestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].ipstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].citystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].countrystring si
$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabelstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].agentstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].lastOriginstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersionstring si
$.oneOf[0].allOf[1].Payload.otherSessions[].buildModestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].clientTypestring si
$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrentboolean si
$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSessionboolean si
$.oneOf[0].allOf[1].Payload.currentSessionIDstring si
$.oneOf[0].allOf[1].Payload.otherSessionCountinteger si
$.oneOf[0].allOf[1].Payload.signedOutboolean si
$.oneOf[0].allOf[1].Payload.redirectUrlstring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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"
    }
}
Documentación del endpoint legible por máquinas