GET /auth/token.json
La mayoría de las funciones del API requieren autenticación y para ello es necesario obtener un token o session id.
Dicho token se debe incluir en la cabecera HTTPAuthentication de la siguiente forma:
Authorization: 854b5c0254572b995b3e96d8a05e31b9
Por otra parte, es importante señalar que tiene una caducidad de 180 sgs. Al finalizar ese tiempo es necesario renovarlo de nuevo.
| GET /auth/token.json | Obtiene el token de conexión para utilizar las funciones del API. |
Parámetros
| Nombre | Tipo | Necesario | Valor por defecto | Descrpción |
|---|---|---|---|---|
| u | Texto | Sí | Ninguno | Nombre de usuario. |
| p | Texto | Sí | Ninguno | Clave del usuario. |
Códigos de respuesta
| Código | Descripción |
|---|---|
| 200 | Resultado correcto |
| 400 | Error en la petición. |
| 401 | Error de autenticación. |
| 403 | Error por falta de permisos. |
| 500 | Error interno del servidor |
Valor devuelto
Devuelve un vector de datos codificado en json
{"status":0,"sessionid":"04eea9a0eedeef04022ecbc2d38b7af3"}
| Nombre | Tipo | Valor por defecto | Descrpción |
|---|---|---|---|
| status | Entero | Ninguno | Estado. |
| sessionid | Texto | Ninguno | Cadena con el token a utilizar. |
Ejemplos
curl -ki "https://10.2.254.222/onm/api/1.0/auth/token.json?u=admin&p=cnm123"
HTTP/1.1 200 OK
Date: Thu, 13 Feb 2014 12:52:26 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 59
Content-Type: text/html; charset=utf-8
{"status":0,"sessionid": "04eea9a0eedeef04022ecbc2d38b7af3"}