Saltar al contenido principal

API Tags

Tags​

Se dispone de una API para manipular las etiquetas de los campos creadas por el usuario. Estas etiquetas cuentan con un texto y un color, y pueden asignarse a un campo. Pueden verse en el selector de campos en la sección superior de la plataforma.

POST​

POST /api/tags_campos/tag

Recibe los siguientes parámetros en la query string:

  • desc:string, (obligatorio.) Descripción de la etiqueta.
  • color:string, (opcional.) color en formato hexadecimal sin "#". Ejemplo: FD37E6. En caso de no enviar el parámetro se asigna un color al azar.
  • id_campo:integer, (opcional.) En caso de ser enviado este parámetro, se asigna al campo correspondiente.

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/tag?id_campo=11111&desc=etiqueta1&color=C51965", {
    method: "POST",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplo de respuesta​

{
  "color": "C51965",
  "res": "creado",
  "tag": "etiqueta1",
  "id_tag": 123,
  "id_campo": 11111
}

Posibles errores​

  • Formato de color inválido
{
  "info": "El color debe tener formato de 6 caracteres sin hash inicial ej FD37E6",
  "res": "err",
  "code": 2
}
  • Nombre de etiqueta existente
{
  "info": "El nombre de la llave ya existe para ese usaurio",
  "res": "err",
  "code": 3
}

PATCH​

PATCH /api/tags_campos/tag

Recibe los siguientes parámetros en la query string:

  • id_tag: integer, (obligatorio.) id de la etiqueta a modificar
  • desc:string, Descripción de la etiqueta.
  • color:string, color en formato hexadecimal sin "#". Ejemplo: FD37E6. En caso de no enviar el parámetro se asigna un color al azar.

⚠️ NOTA: Es obligatorio enviar al menos uno de los dos parámetros (desc o color)

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/tag?id_tag=1234&color=aa00aa&desc=modificada", {
    method: "PATCH",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplo de respuesta​

{
  "color": "aa00aa",
  "id_usuario": 000000,
  "tag": "modificada",
  "id_tag": 1234,
  "res": "modificado"
}

Posibles errores​

  • Formato de color inválido
{
  "info": "El color debe tener formato de 6 caracteres sin hash inicial ej FD37E6",
  "res": "err",
  "code": 2
}
  • ID de la etiqueta inexistente
{
  "info": "Id de tag inexistente",
  "res": "err",
  "code": 3
}
  • Nombre de etiqueta existente
{
  "info": "El nombre de la llave ya existe para ese usaurio",
  "res": "err",
  "code": -6
}

GET​

GET /api/tags_campos/tag

Cuenta con tres formas de uso:

  • tag: traer información de un solo tag.
  • campo: traer información de los tags asociados a un campo.
  • usuario: traer información de todos los tags del usuario.

Dependiendo lo que se pase por la query string, el modo de uso varía.

Si se envía:

  • id_campo:integer, (ID del campo del cual se busca obtener las etiquetas asociadas.) Traerá todas las etiquetas asociadas a un campo.
  • id_tag:integer, (ID de la etiqueta cuya información se busca obtener.) Traerá la información de la etiqueta especificada.
  • Si no se envían parámetros en la query string, el modo de uso corresponde a los tags del usuario. Traerá todos los tags creados por el usuario logeado.

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/tag?id_tag=1234", {
    method: "GET",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplos de respuesta​

tag:

{
  "filter": "tag info",
  "result": {
    "934": {
      "color": "aa00aa",
      "tag": "modificada"
    }
  }
}

campo:

{
  "filter": "farm tags",
  "result": {
    "934": {
      "color": "987A60",
      "tag": "tag2"
    },
    "935": {
      "color": "C51965",
      "tag": "tags"
    }
  }
}

usuario:

{
  "filter": "user tags",
  "result": {
    "934": {
      "color": "987A60",
      "tag": "tag 2"
    },
    "935": {
      "color": "C51965",
      "tag": "tags"
    },
    "936": {
      "color": "50432B",
      "tag": "tag4"
    }
  }
}

DELETE​

DELETE /api/tags_campos/tag

Recibe los siguientes parámetros en la query string:

  • id_tag:integer, (obligatorio.) Descripción de la etiqueta.

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/tag?id_tag=1234", {
    method: "DELETE",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplo de respuesta​

{
  "res": "eliminado",
  "id_tag": 1234
}

Posible error​

{
  "info": "Codigo de tag inexistente",
  "res": "err",
  "code": 3
}

Asociar tags a campos​

POST​

POST /api/tags_campos/asociar

Recibe los siguientes parámetros en la query string:

  • id_tag:integer, (obligatorio.) ID de la etiqueta a ser asociada.
  • id_campo:integer, (obligatorio.) ID del campo al cual asociar la etiqueta.

Retorna las etiquetas totales del campo al que se le asocia la etiqueta.

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/asociar?id_tag=1235&id_campo=111111", {
    method: "POST",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplo de respuesta​

{
  "1234": {
      "tag": "modificada",
      "color": "aa00aa"
  },
  "1235": {
      "tag": "nuevotag",
      "color": "15ffcd"
  }
}

Posibles errores​

{
    "info": "Faltan Parametros",
    "res": "err",
    "code": 1
}

DELETE​

DELETE /api/tags_campos/asociar

Recibe los siguientes parámetros en la query string:

  • id_tag:integer, (obligatorio.) ID de la etiqueta a ser asociada.
  • id_campo:integer, (obligatorio.) ID del campo al cual asociar la etiqueta.

Retorna las etiquetas totales asociadas al campo al que se le desasocia la etiqueta.

Ejemplo de uso​

fetch("https://api.auravant.com/api/tags_campos/asociar?id_tag=1234&id_campo=111111", {
    method: "DELETE",
    headers: {
        Authorization: "Bearer "+token
    }
}).then(resp => resp.json()).then(result => console.log(result))

Ejemplo de respuesta​

{
  "1235": {
      "tag": "nuevotag",
      "color": "15ffcd"
  }
}

Posibles errores​

{
    "info": "Faltan Parametros",
    "res": "err",
    "code": 1
}