Antcas API

Antcas API, verilerini birden fazla uygulama arasında alışveriş etmenizi sağlar.

UYARI: Bu API'yi kullanırken güvenliği dikkate alınız. TLS kullanın ve bu portu asla bir genel erişilebilir adresde kullanmayın.

Not: Her çağrıda API, token'ı doğrulamak zorundadır. Bu, sistem yükünün artmasına neden olabilir.

API Portunun Kurulumu

Yeni bir API portu, Proje Yönetimi altında eklenebilir. Açıklamayı Portu Projeye Atama bölümünde bulabilirsiniz.

Bir istek oluşturabilmek için, bu token ile doğrulanmalıdır. Token'ın oluşturulması, Token Yönetimi bölümünde daha ayrıntılı olarak açıklanmıştır.

Formatlar ve Değerler

API, birkaç giriş formatını destekler: HTTP Sorgu, JSON ve XML. Çıktı HTML, Metin, JSON veya XML olabilir. Karakter kodlaması her zaman UTF-8'dir.

Not: Bir tarayıcı öğesi tarafından yapılan bir çağrı, 428 (Precondition Required) hatasına neden olur. Bu XSS saldırı korumasıdır ve devre dışı bırakılamaz. Bu Antcas Control'a saldırmayı engeller.

POST veya PUT isteğinde, veriler ilgili formatta Content üzerinden yazılabilir. Her değişken büyük/küçük harfe duyarlıdır, yani büyük ve küçük harfler arasında ayrım yapılır. Ancak dönüş her zaman ilan edilen formatta gerçekleşir. Çıktı formatı Header veya format değişkeni üzerinden tanımlanabilir. Giriş formatı her zaman otomatik olarak algılanır.

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

Aşağıdaki formlar Header ve format değişkeni olarak desteklenir:

Content-Type Değişken Format
application/json json JSON
application/xml xml XML
text/plain text Metin
text/csv csv CSV*
(diğer) html HTML

*Sadece çıktı formatı olarak desteklenir.

Not: Metin ve CSV formatları UTF-8 BOM içerir. Bu değişkeni kullanarak bom=FALSE ile devre dışı bırakılabilir.

Bir değer birden fazla formatta tanımlanırsa, son format önceliklidir:

  • HTTP Başlığı (sadece Content-Type üzerinden çıktı formatı)
  • GET
  • POST
  • JSON/XML (POST veya PUT içeriği olarak)

Giriş Değişkenleri

Aşağıdaki değişkenler global olarak tanımlanmıştır.

Değişken Açıklama
format Çıktının formatı.
bom UTF-8 formatında BOM. Varsayılan TRUE'dur.
key Sadece bir değişkeni okur, ilan edildi. Bu yöntem verilerin hazırlanması ve sonra filtrelenmesi gerektiğinden verimsizdir. Sadece küçük veri miktarları için kullanılmalıdır.
header Başlığı yazdır. Varsayılan TRUE'dur.
compact Tüm alt öğeleri birleştirir. Eğer boole değer belirtilmezse, bu değer değişkenleri birleştirmek için kullanılır. Aksi takdirde . değeri kullanılır.
values Sadece değerleri ve değişken adlarını döndürmez. Bu seçenek sadece HTML, CSV ve Metin için mevcuttur.
minimal header=FALSE, compact=minimal ve values=TRUE'un bir kısaltmasıdır.
csvdel CSV ayırıcı. Varsayılan ;'dir
csvenc CSV kapama parantezleri. Varsayılan "'dur
csvesc CSV kaçış karakteri. Varsayılan \'dır

Aşağıdaki değişkenler, global olarak ve tekil değişkenler için de kullanılabilir. Tek bir değişkene ulaşmak için aşağıdaki gibi tanımlanır:

time*:hr=true

Yukarıdaki örnek, time ile başlayan tüm değişkenleri ve time'ı kendisi hedef alır. Tüm kurallar sırayla kontrol edilir. Son uygun kural önceliklidir. Arama düzenli ifadeler kullanılarak yapılır.

Değişken Açıklama
hr İnsan Okunabilir. Değişkenler, mümkünse insanlar için okunabilir verilere dönüştürülür. Varsayılan TRUE'dur HTML, CSV ve Metin formatı için.
numdec Virgülden sonraki basamak sayısı.
numths Bin ayırıcı.
numdot Ondalık ayırıcı.
prefix Değişkene eklemek için metin.
suffix Değişkenden sonra eklemek için metin.

Yollar

Aşağıdaki bölümlerde API'nin tüm uygulamaları tanımlanmıştır.

Alt Sayfalar