Saltar al contenido principal

API de términos

La API de términos permite recuperar, crear, editar y eliminar etiquetas de contacto.

URL

Puedes acceder a la API de términos con la siguiente URL base:

https://<system_id>.<server_id>.quentn.com/public/api/V1/terms

 

Recuperar términos [GET]

URL Parámetro Requerido Requerimientos Descripción
offset No integer Número de registros que se van a omitir (por defecto: 0)
limit No integer Número de registros a devolver (por defecto: 500)

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms?offset=0&limit=500 HTTP/1.1

Respuesta:

[
  {
    "id": 123,
    "name": "Tag 1",
    "description": "Example description",
    "deletion_blocked": false,
  },
  {
    "id": 124,
    "name": "Tag 2",
    "description": "Example description",
    "deletion_blocked": true,
  }
]

 

Retrieve term by id [GET]

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_id>

Respuesta:

{
  "id": 123,
  "name": "Tag 1",
  "description": "Example description",
  "deletion_blocked": false,
}

 

Recuperar término por nombre [GET]

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_name>

Respuesta:

{
  "id": 123,
  "name": "Tag 1",
  "description": "Example description",
  "deletion_blocked": false,
}

 

Crear término [POST]

Ten en cuenta que los nombres de los términos deben ser únicos (sin distinción entre mayúsculas y minúsculas). Si el nombre del término enviado ya existe, se devolverá el ID del término existente.

Petición Parámetro Requerido Requisitos Descripción
Name Yes String Nombre único del término
Description No String Descripción del término

Solicitud body:

{
  "name" : "Tag A",
  "description" : "Sample description"
}

Respuesta:

{
  "id" : 123
}

 

Término de actualización [PUT]

Petición Parámetro Requerido Requisitos Descripción
Name No String Nombre único del término.
Description No String Descripción del término.

Petición:

PUT https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_id>

Solicitud body:

{
  "name" : "New Tag name",
  "description" : "New description"
}

Respuesta:

{
  "success" : "true",
}

Artículos relacionados