Localización y Globalización del API

El API debe permitir la especificación de la cultura en la cual va a recibir la información que se recibe, así como los mensajes de validación y errores en el idioma requerido.

Política de localización y globalización

La política será la siguiente:

1. El consumidor del API puede enviar la cultura en la cual requiere los resultados solicitados, si no lo hace, el API tiene definido por defecto el idioma español.

2. La manera de enviar la cultura puede ser en Querystring o en un encabezado de la petición HTTP.

3. El API enviará en los encabezados de la respuesta la cultura utilizada.

Convención para el envío de la cultura deseada

Si se desea especificar la cultura del API que se desea consultar, el consumidor tiene dos formas de hacerlo:

Enviando la versión en un Request Header

Para utilizar el mecanismo de Request Header se necesita un producto como Postman o similar para poder especificar en la lista de Request Headers la llave "Accept-Language" y en el valor el código de la cultura de dos letras o de cinco letras cuando incluye el país.

Por ejemplo:

Accept-Language: "es"
Accept-Language: "en-US"

Como puede verse en la siguiente imagen, se envía como parte de los encabezados de la petición.

Enviando la cultura en el QuerString

Para utilizar el mecanismo en el QueryString basta con especificarlo junto a la URL

GET /api/estructura/plaza/345?culture=es

Al igual que con el envío a través de los encabezados, la respuesta de la petición indicará qué idioma se utilizó para retornar la información, como puede verse en la imagen presentada anteriormente.