Encabezados aceptados
En cada petición a los recursos de la API se pueden enviar un conjunto de encabezados. Algunas de estos encabezados son obligatorios, otros obligatorios según el recurso (la documentación indica si hay algún encabezado requerido) y otros recomendados.
Encabezado |
Valor admitido |
Descripción |
Obligatorios | ||
X-App-id |
Cadena de texto con el identificador de API. |
Obligatorio en el recurso GET - /auth |
X-App-key |
Cadena de texto con la clave de API. |
Obligatorio en el recurso GET - /auth |
Authorization |
Cadena de texto con el token de autorización. |
Obligatorio para todos los recursos, excepto GET - /auth |
Cookie |
Cookies HTTP. |
Contiene las cookies HTTP almacenadas y enviadas previamente por la API con el encabezado Set-Cookie. Esta permitido que, además de reenviar la colección generada por la API, se añadan otras cookies adicionales. La API las ignora, pero las devuelve en la respuesta. |
basketToken |
Cadena de texto con el token de cesta. |
Requerido en la mayoría de recursos de Cesta y OMS. El token de cesta es devuelto por la API como cookie. Si se reenvía dentro de Cookie junto con las demás cookies no es necesario este encabezado, en caso contrario se deberá enviar. |
cache-hash |
Cadena de texto con un identificador hash. |
Este identificador acelera la gestión de la petición, reduciendo el tiempo de respuesta. El identificador es devuelto por la API como cookie. Si se reenvía dentro de Cookie junto con las demás cookies no es necesario este encabezado, en caso contrario se deberá enviar. |
ip |
Cadena de texto que indica la ipv4. |
Se usa para trasladar la ipv4 del usuario que está interactuando en la capa de presentación del Commerce. Con esta cabecera se calcula su país de origen. |
Content-Type |
application/json |
Indica que el tipo de contenido es en formato JSON. |
Recomendados | ||
userAgent |
Cadena de texto representativa del user-agent. |
Se usa para trasladar el encabezado User-Agent del usuario que está interactuando en la capa de presentación del Commerce, que en general es diferente del user-agent del cliente HTTP que ejecuta la petición a la API. La información de esta cadena puede ser usada para determinar el canal de venta. |
referer |
Cadena de texto que indica la dirección de la página web que creó el vínculo con el recurso que está siendo visitado. |
Se usa para trasladar el encabezado Referer del usuario que está interactuando en la capa de presentación del Commerce. En caso necesario, se debe sobreescribir el encabezado del cliente HTTP que ejecuta la petición a la API. La información de esta cadena puede ser usada para determinar el canal de venta. |
Accept |
application/json |
Indica que el cliente HTTP puede aceptar respuestas en formato JSON. |
Es posible que algún recurso necesite algún encabezado adicional más, en cuyo caso, la documentación del recurso lo especificará.