Antcas API

A Antcas API permite trocar dados entre vários aplicativos.

AVISO: Tenha cuidado com a segurança ao usar esta API. Use apenas TLS e nunca use a porta em um endereço público.

Nota: Como o API deve verificar o token em cada chamada, isso pode resultar em uma carga de sistema mais elevada.

Configurar uma Porta de API

Na Gerenciamento de Projeto, pode-se adicionar um novo Porta de API. A descrição está no capítulo Atribuir Porta ao Projeto.

Para que uma solicitação possa ser criada, ela deve ser autenticada por meio de Token. A criação de um token é explicada em detalhes no capítulo Gerenciar Token.

Formatos e Valores

A API suporta vários formatos de entrada: Consultas HTTP, JSON e XML. A saída pode ser em HTML, Texto, JSON ou XML. A codificação de caracteres é sempre UTF-8.

Nota: Uma chamada por um elemento no navegador resulta no erro 428 (Precondition Required). Isso é a proteção contra ataques XSS e não pode ser contornada. Isso impede um ataque de hacking ao Antcas Control.

Em uma solicitação POST ou PUT, os dados podem ser escritos no conteúdo no formato correspondente. Cada variável é sensível a maiúsculas e minúsculas, o que significa que há distinção entre letras maiúsculas e minúsculas. No entanto, a resposta sempre ocorre no formato declarado. O formato de saída pode ser descrito via cabeçalho ou pela variável format. O formato de entrada é sempre reconhecido automaticamente.

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

Os seguintes formatos são suportados no cabeçalho e na variável format:

Content-Type Variável Formato
application/json json JSON
application/xml xml XML
text/plain text Texto
text/csv csv CSV*
(outros) html HTML

*Suportado apenas como formato de saída.

Nota: Os formatos Texto e CSV contêm o UTF-8 BOM. Este pode ser desativado usando a variável bom=FALSE.

Se um valor for descrito por vários formatos, o formato posterior terá prioridade:

  • Cabeçalho HTTP (apenas formato de saída via Content-Type)
  • GET
  • POST
  • JSON/XML (como conteúdo POST ou PUT)

Variáveis de Entrada

As seguintes variáveis são definidas globalmente.

Variável Descrição
format Formato da saída.
bom BOM no formato UTF-8. O padrão é TRUE.
key Lê apenas uma variável que foi declarada. Este método é ineficiente, pois todos os dados são preparados e filtrados apenas depois. Deve ser usado apenas com pequenas quantidades de dados.
header Exibir cabeçalho. O padrão é TRUE.
compact Agrupa todos os subelementos em si mesmo. Se nenhum valor booleano for declarado, este valor será usado para agrupar as variáveis. Caso contrário, o valor . será usado.
values Retorna apenas os valores e não os nomes das variáveis. Esta opção está disponível apenas para HTML, CSV e Texto.
minimal Alias para header=FALSE, compact=minimal e values=TRUE.
csvdel Delimitador CSV. O padrão é ;
csvenc Parênteses de fechamento CSV. O padrão é "
csvesc Caractere de escape CSV. O padrão é \

As seguintes variáveis podem ser usadas globalmente, bem como para variáveis individuais. Para acessar uma única variável, ela é definida da seguinte forma:

time*:hr=true

O exemplo acima se refere a todas as variáveis começando com time e time em si. Todas as regras são verificadas em ordem. Assim, a última regra correspondente tem precedência. A busca é feita usando expressão regular.

Variável Descrição
hr Legível por Humanos. As variáveis são convertidas, se possível, em dados legíveis para humanos. O padrão é TRUE para o formato HTML, CSV e Texto.
numdec Número de casas decimais.
numths Separador de milhares.
numdot Separador decimal.
prefix Adicionar texto antes da variável.
suffix Adicionar texto após a variável.

Caminhos

Nos capítulos abaixo estão definidas todas as aplicações da API.

Páginas Subordinadas