Autenticar una solicitud
- Los WS API deben estar activados para poder acceder a ellos.
- Los protocolos disponibles son HTTP y HTTPS. Si es posible, se recomienda emplear el HTTPS.
- Cada solicitud debe incluir la siguiente cabecera:
Nombre de cabecera: X-Auth-Token
Valor: Valor token (ejemplo: a08443af-cc58-4e3e-b557-13be8de66230)
- No se puede realizar ningún otro tipo de autenticación para acceder a los WS API.
Encontrar el valor token
Se puede encontrar este valor en la página http://[learningcentral_customer_domain]/admin/clientauthtoken
Tan solo necesita iniciar la sesión en learningCentral con el rol de usuario soporte.
Generar un nuevo token
Este valor puede generarse aquí http://[learningcentral_customer_domain]/admin/clientauthtoken
...
| Note |
|---|
AVISO: El nuevo valor reemplazará al antiguo, por lo que cualquier sistema externo que utilice los WS API debe iniciarse utilizando el nuevo token. |
Versión del API
La versión actual del API proporcionada por central es la v2, que usa el nuevo sistema de versionado.
Urls
Desde la versión 6.6 de la plataforma, se produce un cambio en el sistema de versionado del API, dejando como obsoleto el versionado por url y pasando a usar el sistema recomendado de versionado mediante cabeceras Accept.
...
Las nuevas urls serán del tipo "/admin/rest/administration/api/<recurso>..." y se usará una versión u otra según el valor enviado en la cabecera Accept
Formato cabecera Accept
El formato de la cabecera para indicar una versión en concreto será "application/vnd.netex.nlc-api{.vX}+{type}"
...
- .vX: indicará una versión en concreto. Ejemplo ".v1". Si no se indica se usará la última
- type: indicará el tipo de retorno (json, xml, plain,..)
...
Examples:
| Accept (JSON) | Accept (Plain) | Versión |
|---|
| Usará la última versión disponible del servicio web | ||
*/* | */* | Usará la última versión disponible del servicio web |
application/json | text/plain | Usará la última versión disponible del servicio web |
application/vnd.netex.nlc-api+json | application/vnd.netex.nlc-api+plain | Usará la última versión disponible del servicio web |
application/vnd.netex.nlc-api.v1+json | application/vnd.netex.nlc-api.v1+plain | Usará la versión 1 del API (la misma que con la url antigua) |
application/vnd.netex.nlc-api.v2+json | application/vnd.netex.nlc-api.v2+plain | Usará la versión 2 del API (si el servicio web en concreto no tiene una nueva versión se usará la versión anterior) |
...