netexCloud - API de Web Services | Encabezado

Última modificación:

Encabezado de la versión/formato

Para especificar la versión del web services o el formato en el que queremos la respuesta debemos enviar el encabezado Accept:

application/vnd.acme.nlc-api(.{version})?(+{format})?

version: opcional. Los valores permitidos son:

  • management: v1.0.0, v1.0.1. Si no se especifica ningún valor se utilizará la última versión
  • training: v1, v2. Si no se especifica ningún valor se utilizará la última versión.

format: opcional. Los valores permitidos son json, plain y xml. Si no se especifica ningún valor se utilizará json.

* El encabezado no tendrá efecto si la sección es social.

* El encabezado no tendrá efecto si la sección es management (siempre se utiliza la última versión y json).

Encabezado de autorización

Debemos enviar el encabezado X-Cloud-Auth-Token para especificar la autorización del WS. El valor de este encabezado se puede obtener en learningCloud (“Your account”)

Encabezado de sincronización

Debemos enviar el encabezado header X-Cloud-Synchronization para especificar la sincronización del WS. Los valores permitidos son:

  • synchronous: versión síncrona del WS. Cuando se realiza una llamada a un WS de Cloud con este tipo, las llamadas al resto de plataformas (Central, Social, etc) que realiza el servicio web se ejecutan de forma síncrona. Es decir, se espera a que cada una de estas llamadas finalice para devolver el resultado de la llamada al servicio. De esta manera, las llamadas a este tipo de servicio son, por norma general, más lentas que las de tipo asíncrono pero nos aseguramos que los cambios realizados se han propagado al resto de las plataformas. En caso de que se produzca un error en alguna de las llamadas a las plataformas, se nos informará en la respuesta.
  • asynchronous: versión asíncrona del WS. Cuando se realiza una llamada a un WS de Cloud con este tipo, cada llamada a las demás plataformas que realice el servicio, genera un mensaje en una cola que será procesado de forma asíncrona. No se espera a obtener respuesta de los WS de las demás plataformas con lo que, por norma general, este tipo de llamadas tienen un tiempo de respuesta menor que las de tipo síncrono. Sin embargo, no se asegura que los cambios se hayan propagado en las demás plataformas una vez que obtengamos la respuesta de finalización del servicio. Por tanto no sabremos de manera inmediata si las operaciones se realizan con éxito o ocurre algún error.

Si no se especifica ningún valor se utilizará asynchronous.


¿Le resulta útil este artículo?
© 2021 Netex Knowledge Factory. Todos los derechos reservados. Aviso Legal | Política de Privacidad | Política de Cookies.