Antcas API

La Antcas API permite intercambiar datos entre varias aplicaciones.

ADVERTENCIA: Tenga en cuenta la seguridad al utilizar esta API. Utilice solo TLS y nunca utilice el puerto en una dirección accesible públicamente.

Nota: Dado que la API debe verificar el token en cada llamada, esto puede resultar en una mayor carga del sistema.

Configurar un puerto de API

En la Gestión del proyecto se puede agregar un nuevo Puerto de API. La descripción se encuentra en el capítulo Asignar puerto al proyecto.

Para que una solicitud pueda ser creada, debe ser autenticada mediante Token. La creación de un token se explica con más detalle en el capítulo Administrar tokens.

Formatos y valores

La API admite varios formatos de entrada: Consultas HTTP, JSON y XML. La salida puede ser HTML, texto, JSON o XML. La codificación de caracteres es siempre UTF-8.

Nota: Una llamada a través de un elemento en el navegador resulta en el error 428 (Precondition Required). Esto es la protección contra ataques XSS y no puede ser desactivada. Esto evita un ataque de hackeo a Antcas Control.

En una solicitud POST o PUT, los datos pueden escribirse en el contenido en el formato correspondiente. Cada variable es sensible a mayúsculas y minúsculas, lo que significa que se distingue entre mayúsculas y minúsculas. Sin embargo, la devolución siempre se realiza en el formato declarado. El formato de salida puede describirse mediante el encabezado o mediante la variable format. El formato de entrada siempre se reconoce automáticamente.

GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json

A continuación, se muestran los formatos admitidos en el encabezado y como variable de formato:

Content-Type Variable Formato
application/json json JSON
application/xml xml XML
text/plain text Texto
text/csv csv CSV*
(otro) html HTML

*Solo se admite como formato de salida.

Nota: Los formatos Texto y CSV contienen el UTF-8 BOM. Este puede ser desactivado mediante la variable bom=FALSE.

Si un valor se describe a través de varios formatos, el formato posterior tiene prioridad:

  • Encabezado HTTP (solo formato de salida mediante Content-Type)
  • GET
  • POST
  • JSON/XML (como contenido POST o PUT)

Variables de entrada

A continuación, se definen las variables globales.

Variable Descripción
format Formato de salida.
bom BOM en formato UTF-8. El valor predeterminado es TRUE.
key Lee solo una variable que se ha declarado. Este método es ineficiente, ya que todos los datos se preparan y luego se filtran. Solo debe utilizarse con pequeñas cantidades de datos.
header Mostrar encabezado. El valor predeterminado es TRUE.
compact Agrupa todos los subelementos. Si no se declara un valor booleano, se utiliza este valor para agrupar las variables. De lo contrario, se utiliza el valor ..
values Devuelve solo los valores y no los nombres de las variables. Esta opción está disponible solo para HTML, CSV y Texto.
minimal Alias para header=FALSE, compact=minimal y values=TRUE.
csvdel Delimitador CSV. El valor predeterminado es ;
csvenc Paréntesis de cierre CSV. El valor predeterminado es "
csvesc Carácter de escape CSV. El valor predeterminado es \

A continuación, se muestran las variables que pueden utilizarse globalmente y también para variables individuales. Para dirigirse a una variable individual, esta se define de la siguiente manera:

time*:hr=true

El ejemplo anterior se refiere a todas las variables que comienzan con time y time en sí mismo. Se verifican todas las reglas en orden. Por lo tanto, la última regla adecuada tiene prioridad. La búsqueda se realiza mediante expresión regular.

Variable Descripción
hr Legible por humanos. Las variables se convierten, si es posible, en datos legibles para humanos. El valor predeterminado es TRUE para el formato HTML, CSV y Texto.
numdec Número de decimales.
numths Separador de miles.
numdot Separador decimal.
prefix Agregar texto antes de la variable.
suffix Agregar texto después de la variable.

Rutas

En los capítulos siguientes se definen todas las aplicaciones de la API.

Páginas Subordinadas