POST api/AUTH/1/0/Login
Funcion de compatibilidad, no usar, se eliminará en siguiente release
Información del Request
Parametros de la URI
No posee parametros
Parametros del Body
Objeto que contiene los parámetros de la petición
SFE.Auth.Core.Requests.LoginRequest| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| userName |
Nombre de usuario |
string |
Required Matching regular expression pattern: ^[a-zA-Z0-9\-_]+$ String length: inclusive between 3 and 100 |
| password |
Contaseña, encriptada con la llave pública del servidor y codificada en Base64UrlEncoded |
string |
Required Matching regular expression pattern: ^[.\-_A-Za-z0-9+/]*={0,3}$ String length: inclusive between 0 and 8192 |
| clientDevicePublicKey |
Llave pública RSA del dispositivo cliente en formato Base64UrlEncoded |
string |
Required Matching regular expression pattern: ^[.\-_A-Za-z0-9+/]*={0,3}$ String length: inclusive between 0 and 8192 |
| bearerToken |
Token de autenticación usado por el dispositivo |
string |
Required Matching regular expression pattern: ^[.\-_A-Za-z0-9+/]*={0,3}$ String length: inclusive between 0 and 8000 |
| encAlgorithm |
Tipo de algoritmo para el cifrado del password |
integer |
N/A |
| applicationId |
Identificador de la aplicación que consume el API. Valor constante acordado con el cliente |
string |
N/A |
| applicationVersion |
Identificador de la versión de la aplicación |
string |
Max length: 100 |
| applicationOS |
Identificador del sistema operativo de la aplicación (en mayúsculas) Ejemplo: ANDROID, IOS |
string |
Max length: 100 |
| language |
Código ISO 639-1 de dos letras del idioma usado para los mensajes |
string |
Max length: 5 |
| deviceId |
Identificador del dispositivo registrado |
integer |
N/A |
| deviceAltId |
Identificador alternativo del dispositivo registrado |
string |
Max length: 128 |
| ipAddress |
Dirección IP pública del dispositivo |
string |
Matching regular expression pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} |
| latitude |
Latitud dela ubicación enviada por dispositivo |
string |
Max length: 50 |
| longitude |
Longitud dela ubicación enviada por dispositivo |
string |
Max length: 50 |
| additionalParameters |
Datos adicionales |
Dictionary of string [key] and string [value] |
N/A |
Ejemplos de request:
application/json, text/json
{
"userName": "sample string 1",
"password": "sample string 2",
"clientDevicePublicKey": "sample string 3",
"bearerToken": "sample string 4",
"encAlgorithm": 5,
"applicationId": "sample string 6",
"applicationVersion": "sample string 7",
"applicationOS": "sample string 8",
"language": "sample string 9",
"deviceId": 10,
"deviceAltId": "sample string 11",
"ipAddress": "sample string 12",
"latitude": "sample string 13",
"longitude": "sample string 14",
"additionalParameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
<additionalParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</additionalParameters>
<applicationId>sample string 6</applicationId>
<applicationOS>sample string 8</applicationOS>
<applicationVersion>sample string 7</applicationVersion>
<deviceAltId>sample string 11</deviceAltId>
<deviceId>10</deviceId>
<ipAddress>sample string 12</ipAddress>
<language>sample string 9</language>
<latitude>sample string 13</latitude>
<longitude>sample string 14</longitude>
<bearerToken>sample string 4</bearerToken>
<clientDevicePublicKey>sample string 3</clientDevicePublicKey>
<encAlgorithm>5</encAlgorithm>
<password>sample string 2</password>
<userName>sample string 1</userName>
</LoginRequest>
Información del Response
Descripción de los parametros
KinPOS.API.Controllers.AUTH.AuthController+LoginV10Response| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| session |
Información sobre la sesión de usuario |
SFE.Auth.Plugin.Shared.Models.AUTH.SessionInfo |
N/A |
| loginInfo |
Información adicional sobre usuario y sesión |
SFE.Auth.Core.Model.UserLoginInfo |
N/A |
| result |
Resultado del proceso |
SFE.Shared.TextUtils.ProcessResult |
N/A |
| additionalData |
Información producida por el postproceso de esta peticíón Ejemplos: cmsAccountId Identificador de la cuenta CMS (cuenta virtual), en caso de que se haya creado una cmsProgramId Identificador del programa CMS al que va asociada a la cuenta CMS creada |
Dictionary of string [key] and string [value] |
N/A |
| NextStepFields | Collection of SFE.Auth.Plugin.Shared.Model.StepField |
N/A |
|
| nextStepName |
Orden del paso siguiente de registro |
string |
N/A |
| nextStepId |
Id del paso siguiente de registro |
integer |
N/A |
| nextStepOrder |
Orden del paso siguiente de registro |
integer |
N/A |
| PreviousStepFields | Collection of SFE.Auth.Plugin.Shared.Model.StepField |
N/A |
|
| PreviousStepName | string |
N/A |
|
| PreviousStepId | integer |
N/A |
|
| PreviousStepOrder | integer |
N/A |
|
| stopCode |
Código de detención, solo en caso de que el proceso deba detenerse. |
SFE.Auth.Core.Model.EnumStopCode |
N/A |
Ejemplos de response:
application/json, text/json
Ejemplo no disponible.