Authentication - API Token
Es el método de la API de la plataforma WIFI empleado para autenticarse y obtener el API Token que deberá ser enviado en todas las peticiones realizadas posteriormente a la API.
GET -Â Return API_Token
Devuelve el token para el usuario y contraseña indicado en la cabecera mediante el parámetro Authorization. Este token debe ser incluido en todas las peticiones que se realicen posteriormente para poder validar al usuario.
https://<server-domainname>/rest/login |
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
---|---|---|---|---|---|
HEAD | Authorization | Usuario y contraseña en formato basic auth | string | SI | - |
El usuario y contraseña debe enviarse codificado en Base64. Los pasos a seguir para poder construir el contenido a enviar en el parámetro Authorization son:
Construir el string con el formato usuario - contraseña
Codificar el string en Base64
Añadir a la petición la cabecera "Authorization" con el contenido "Basic " seguido del string codificado en Base64.
Por ejemplo, para el usuario USER y contraseña PASSWORD se obtendrÃa el string USER:PASSWORD, codificado en base64 como VVNFUjpQQVNTV09SRA==, por lo que la petición a realizar para obtener el API Token para este usuario quedarÃa de la siguiente manera:
curl -D- -X GET -H "Authorization: Basic VVNFUjpQQVNTV09SRA==" -H "Content-Type: application/json" "https://<server-domainname>/rest/login" |
Respuesta
HTTP CODE | RESULTADO | DATOS DE RESPUESTA |
---|---|---|
200 | Ok | [
"api_key",
"203BB1A4690CAD"
] |
400 | Bad Request | Incorrect params, not o malformed header |
401 | Unauthorized | Password incorrect |
403 | Forbidden | User not exist |