Etiquetas en la API

Las etiquetas permiten categorizar los proveedores según el tipo de ocio que ofrecen. Algunos ejemplos de categorías son:

  • Parques temáticos
  • Espectáculos
  • Museos
  • Conciertos

Cada proveedor puede tener asignadas una o varias etiquetas. Los identificadores de estas etiquetas se pueden consultar dentro del catálogo de productos, a nivel de proveedor.

1. Método de Acceso

Parámetro

Descripción

URL

https://demo.api.experticket.com/api/tags?PartnerId=ptfhni79b311e

Verbo HTTP

GET

Longitud máxima de la URL

2048 caracteres

 

2. Estructura de Datos de Envío

Parámetros Obligatorios

Parámetro

Descripción

PartnerId

Identificador único del colaborador.

Parámetros Opcionales

Parámetro

Descripción

LanguageCode

Define el idioma en que se mostrarán las etiquetas.

api-version

Versión de la API a utilizar (por defecto 3.21).

Idiomas Disponibles para LanguageCode

  • es → Español
  • en → Inglés
  • fr → Francés
  • pt → Portugués
  • ca-ES → Catalán
  • it → Italiano
  • zh-CN → Chino simplificado

3. Ejemplos de Uso

Obtener la Lista Completa de Etiquetas

GET https://demo.api.experticket.com/api/tags?PartnerId=ptfhni79b311e

Obtener la Lista en un Idioma Específico

GET https://demo.api.experticket.com/api/tags?PartnerId=ptfhni79b311e&LanguageCode=es

Consultar la Lista Usando una Versión Específica de la API

GET https://demo.api.experticket.com/api/tags?PartnerId=ptfhni79b311e&api-version=3.60

4. Estructura de la Respuesta

La API devuelve un array de etiquetas, donde cada etiqueta puede tener subcategorías anidadas.

{

  "Tags": [

    {

      "Id": "by81fymhsmjgw",

      "Key": 101,

      "Name": "Espectáculos",

      "PathName": "Entretenimiento / Espectáculos",

      "Children": [

        {

          "Id": "mzn18jfi32awe",

          "Key": 102,

          "Name": "Conciertos",

          "PathName": "Entretenimiento / Espectáculos / Conciertos",

          "Children": []

        },

        {

          "Id": "o8dh24kld9e3p",

          "Key": 103,

          "Name": "Teatros",

          "PathName": "Entretenimiento / Espectáculos / Teatros",

          "Children": []

        }

      ]

    },

    {

      "Id": "r2ldhsk93kqpe",

      "Key": 201,

      "Name": "Parques temáticos",

      "PathName": "Ocio / Parques temáticos",

      "Children": []

    }

  ],

  "Success": true,

  "Timestamp": "2025-01-15T12:34:56Z",

  "ErrorMessage": null,

  "ErrorCodes": []

}

 

5. Explicación de la Respuesta

Campo

Descripción

Tags

Array de etiquetas disponibles.

Id

Identificador único de la etiqueta.

Key

Clave numérica única de la etiqueta.

Name

Nombre de la etiqueta (ej. "Teatros y espectáculos").

PathName

Ruta jerárquica de la etiqueta.

Children

Subcategorías dentro de la etiqueta (puede haber múltiples niveles).

Success

Indica si la consulta se realizó con éxito.

Timestamp

Fecha y hora de la consulta.

ErrorMessage

Mensaje de error (si aplica).

ErrorCodes

Lista de códigos de error (si aplica).

6. Consideraciones Finales

  • Estructura Jerárquica: Algunas etiquetas tienen subcategorías dentro de ellas (ej. "Espectáculos" → "Conciertos").
  • Consulta por Idioma: Se recomienda especificar LanguageCode para obtener los nombres de etiquetas en el idioma deseado.
  • Uso en el Catálogo: Los proveedores pueden estar categorizados con estas etiquetas dentro del catálogo de productos.

Este endpoint es útil para organizar y clasificar los proveedores según el tipo de entretenimiento que ofrecen.

¿Te ha parecido útil este artículo?

LEARNING PATHS