Saltar al contenido principal

API de campos personalizados

La API de campos personalizados te permite recuperar información sobre los campos personalizados existentes. También puedes crear nuevos campos y actualizar o eliminar campos existentes.

URL

Puedes acceder a la API de campos personalizados con la siguiente URL base:

https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields

Recuperar información sobre campos personalizados [GET]

Petición:
GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields HTTP/1.1

Respuesta:

[
  {
    "field_id": 123,
    "field_name": "field_customer_id",
    "label": "Customer ID",
    "description": "Example description",
    "type": "text_textfield",
    "field_type": "text",
    "required": false,
  },
  {
    "field_id": 156,
    "field_name": "field_confirmation",
    "label": "Cookie confirmation",
    "description": "Example description",
    "type": "checkbox_confirmation",
    "field_type": "checkbox_confirmation",
    "required": true,
  }
]

Recuperar información sobre un campo personalizado por id [GET]

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_id>

Respuesta:

{
    "field_id": 123,
    "field_name": "field_customer_id",
    "label": "Customer ID",
    "description": "Example description",
    "type": "text_textfield",
    "field_type": "text",
    "required": false,
}

Recuperar información sobre un campo personalizado por nombre [GET]

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_name>

Respuesta:

{
    "field_id": 156,
    "field_name": "field_confirmation",
    "label": "Cookie confirmation",
    "description": "Example description",
    "type": "checkbox_confirmation",
    "field_type": "checkbox_confirmation",
    "required": true,
}

 

Crear campo personalizado [POST]

Petición:

POST https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields HTTP/1.1

Solicitud body:

{
    "label": "My new textfield",
    "description": "Example description",
    "field_type": "text",
    "max_length": 128,
}

Respuesta:

{
    "success": true,
    "field_name": "field_my_new_textfield",
    "field_id": 278,
}

 

Opciones disponibles para todos los tipos de campo

Petición Parámetro Requerido Requerimiento Descripción
field_type Yes string

Tipo del campo personalizado. Los tipos posibles son: "text", "selection", "date", "integer", "float", "checkbox_confirmation", "url".
label Yes string (32)

Etiqueta visible del campo.
description No string

Descripción del campo.
field_name No string (26)

Este nombre se utilizará como identificador único del campo. Puede contener letras, números y guiones bajos. Llevará automáticamente el prefijo "field_". Si se omite, se generará automáticamente a partir de la etiqueta.

 

Opciones disponibles para tipos de campo específicos

Tipo de campo: texto

Descripción: campo de texto simple de hasta 255 caracteres.

Petición Parámetro Requerido Requerimiento Descripción
size No int
min.: 2
max.: 60

Tamaño del campo de texto que se muestra en el formulario de contacto del área de administración. Por defecto: 30.
max_length No int
max.: 255

Número máximo de caracteres. Los valores posibles son: 8, 16, 32, 64, 128, 255. Por defecto 255.

 

Tipo de campo: selección

Descripción: selección de valores predefinidos. Este tipo de campo puede mostrarse como selección desplegable, botones de radio o casillas de verificación.

Petición Parámetro Requerido Requerimiento Descripción
field_type_option Yes string

Tipo de la selección. Los valores posibles son: "seleccionar", "radios", "casillas de verificación". Cuando esta opción está configurada como "casillas de verificación", el usuario puede seleccionar varias opciones. En caso contrario, sólo se puede seleccionar una opción.
options Yes array

Pares clave-valor con las opciones disponibles. La longitud máxima es de 255 caracteres por clave o valor. Una clave puede contener letras minúsculas, números y guiones bajos. "select" y "radios" pueden tener hasta 100 opciones, mientras que "checkboxes" sólo pueden tener 50 opciones.
default_value No string or array

Define el valor por defecto, seleccionado en la lista. Debe ser la clave de una opción. En el caso de las "casillas de verificación", la(s) clave(s) debe(n) estar en una matriz. Para "selección" y "radios" debe ser cadena.

 

Tipo de campo: fecha

Descripción: campo para almacenar fechas, con o sin hora.

Petición Parámetro Requerido Requerimiento Descripción
granularity Yes string

Define si el campo almacena una fecha con o sin hora. Los valores posibles son: "date_time" y "date_only".

 

Tipo de campo: entero

Descripción: campo para almacenar números enteros.

Petición Parámetro Requerido Requerimiento Descripción
min No int

Valor mínimo de un número que debe almacenarse en ese campo.
max No int

Valor máximo de un número que debe almacenarse en ese campo. Debe ser mayor que 0.

 

Tipo de campo: float

Descripción: campo para almacenar números flotantes.

Petición Parámetro Requerido Requerimiento Descripción
decimal_marker Yes string

Carácter utilizado para separar el rango entero del rango decimal. Los valores posibles son "." y ","
min No float

Valor mínimo de un número que debe almacenarse en ese campo
max No float

Valor máximo de un número que debe almacenarse en ese campo. Debe ser mayor que 0.

 

Tipo de campo: checkbox_confirmation

Descripción: proporciona una casilla de verificación para guardar la confirmación de un contacto. También mostrará un texto de descripción con un enlace opcional a un sitio web con más información.

Petición Parámetro Requerido Requerimiento Descripción
confirmation_text Yes string

Este texto se mostrará junto a la casilla de verificación. Puede utilizar "[enlace]" como marcador de posición en el texto. Este marcador de posición se sustituirá por un enlace, que se creará a partir de los parámetros de solicitud "link_text" y "link_url".
link_text No string

Si está presente, se utilizará para la parte visible del enlace que sustituye al marcador de posición "[link]" en el texto de confirmación.
link_url No string

Si está presente, se utilizará como URL de destino del enlace que sustituye al marcador de posición "[link]" en el texto de confirmación.

 

Tipo de campo: url

Descripción: un campo de texto simple para almacenar URLs.

Este tipo de campo no tiene opciones.

 

Actualizar campo personalizado [PUT]

Petición:

PUT https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_name> HTTP/1.1

Solicitud body:

{
    "label": "My renamed textfield",
    "description": "Example description",
    "size": 10,
}

Respuesta:

{
    "success": true,
    "field_name": "field_my_new_textfield",
    "field_id": 278,
}

 

Opciones disponibles para todos los tipos de campo

Petición Parámetro Requerido Requerimiento Descripción
label No string (32)

Etiqueta visible del campo.
description No string

Descripción del campo

 

Opciones disponibles para tipos de campo específicos

Tipo de campo: texto

Descripción: campo de texto simple de hasta 255 caracteres.

Petición Parámetro Requerido Requerimiento Descripción
size No int
min.: 2
max.: 60

Tamaño del campo de texto que se muestra en el formulario de contacto del área de administración. Por defecto: 30.

 

Tipo de campo: selección

Descripción: una selección de valores predefinidos. Este tipo de campo puede mostrarse como selección desplegable, botones de radio o casillas de verificación.

Petición Parámetro Requerido Requerimiento Descripción
field_type_option No string

Tipo de la selección. Los valores posibles son: "select", "radios", "checkboxes". Sólo es posible cambiar entre "select" y "radios" (selección única), mientras que "checkboxes" (selección múltiple) no se puede cambiar.
options No array

Pares clave-valor con las opciones disponibles. La longitud máxima es de 255 caracteres por clave o valor. Una clave puede contener letras minúsculas, números y guiones bajos. "select" y "radios" pueden tener hasta 100 opciones, mientras que "checkboxes" sólo puede tener 50 opciones.
default_value No string or array

Define el valor por defecto, seleccionado en la lista. Debe ser la clave de una opción. En el caso de las "casillas de verificación", la(s) clave(s) debe(n) estar en una matriz. Para "selección" y "radios" debe ser string.

 

Tipo de campo: fecha

Descripción: campo para almacenar fechas, con o sin hora.

Este tipo de campo no tiene opciones.

 

Tipo de campo: entero

Descripción: campo para almacenar números enteros.

Petición Parámetro Requerido Requerimiento Descripción
min No int

Valor mínimo de un número que debe almacenarse en ese campo.
max No int

Valor máximo de un número que debe almacenarse en ese campo. Debe ser mayor que 0.

 

Tipo de campo: float

Descripción: campo para almacenar números flotantes.

Petición Parámetro Requerido Requerimiento Descripción
decimal_marker No string

Carácter utilizado para separar el rango entero del rango decimal. Los valores posibles son "." y ",".
min No float

Valor mínimo de un número que debe almacenarse en ese campo.
max No float

Valor máximo de un número que debe almacenarse en ese campo. Debe ser mayor que 0.

 

Tipo de campo: checkbox_confirmation

Descripción: proporciona una casilla de verificación para guardar la confirmación de un contacto. También mostrará un texto de descripción con un enlace opcional a un sitio web con más información.

Petición Parámetro Requerido Requerimiento Descripción
confirmation_text No string

Este texto se mostrará junto a la casilla de verificación. Puede utilizar "[link]" como marcador de posición en el texto. Este marcador de posición se sustituirá por un enlace, que se creará a partir de los parámetros de solicitud "link_text" y "link_url".
link_text No string

Si está presente, se utilizará para la parte visible del enlace que sustituye al marcador de posición "[link]" en el texto de confirmación.
link_url No string

Si está presente, se utilizará como URL de destino del enlace que sustituye al marcador de posición "[link]" en el texto de confirmación.

 

Tipo de campo: url

Descripción: campo de texto simple para almacenar URL.

Este tipo de campo no tiene opciones.

 

 

Borrar campo personalizado [DELETE]

Esto eliminará el campo personalizado y todos sus datos. No se puede deshacer.

Petición:

DELETE https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_name> HTTP/1.1

Respuesta:

{
    "success": true,
    "field_name": "field_my_textfield",
}

Artículos relacionados