Header

Haberleşme ünitesinin, haberleşme merkezi yazılımı ile iletişimi sırasında gönderilen ve alınan tüm paketlerde bir başlık (header) yapısı bulunmaktadır.

Başlık Formatı

Tüm mesajlarda bulunacak başlık yapısıdır.

MQTT

{
  "device": {
    "flag": "XYZ",
    "serialNumber": "0123456789ABCDE"
  },
  "function": "fonksiyonAdi",
  "referenceId": "3d0b242e-1866-4a41-a8ca-1372f1b34ab7",
  "streaming": true|false,
  "packageNo": 3,
  "encryption": "AES-128",
  "compression": "base64"
}

TCP/IP

{
  "device": {
    "flag": "XYZ",
    "serialNumber": "0123456789ABCDE"
  },
  "function": "fonksiyonAdi",
  "referenceId": "3d0b242e-1866-4a41-a8ca-1372f1b34ab7",
  "requestMethod": "sync|async",
  "encryption": "AES-128",
  "compression": "base64"
}

REST API

{
  "device": {
    "flag": "XYZ",
    "serialNumber": "0123456789ABCDE"
  },
  "function": "fonksiyonAdi",
  "referenceId": "3d0b242e-1866-4a41-a8ca-1372f1b34ab7",
  "encryption": "AES-128",
  "compression": "base64"
}

Parametre	Veri Tipi	Zorunluluk	Açıklama
function	string	Zorunlu	Kullanılan protokol fonksiyonu ismi
referenceId	string	Zorunlu	Haberleşme merkezi yazılımı ile haberleşme ünitesi arasında gerçekleştirilen her bir iletişim için benzersiz olan ID bilgisi. GUID/UUID olarak üretilecektir.
requestMethod	string	Opsiyonel	TCP/IP haberleşme yönteminde, haberleşmenin işleyiş biçimini belirtir. async ve sync değerlerini alabilir.
streaming	bool	Opsiyonel	Mevcut mesajın sonrasında gönderilmeyi bekleyen başka mesaj olup, olmamasıyla alakalı işaret parametresi. Eğer true ise gönderilmeyi bekleyen başka mesaj mevcut, false ise başka mesaj yok. Eğer header içerisinde yok ise false anlamı taşımaktadır.
packageNo	byte	Opsiyonel	Parçalı mesaj gönderimlerinde mevcut paketin sıra numarası. Eğer header içinde yok ise mesajın tek pakette iletildiği anlamına gelmektedir.
encryption	string	Opsiyonel	Gönderilen mesajın request alanı için şifrelemek için kullanılan algortima bilgisi. Eğer yok ise şifreleme yok anlamına gelmektedir.
compression	string	Opsiyonel	Mesajın request alanı için kullanılan veri sıkıştırma algortiması. Eğer header içinde yok ise veri sıkıştırması yapılmamıştır.

device nesnesi

ÖNEMLİ

device nesnesi; MQTT haberleşmede opsiyoneldir. Diğer tüm haberleşme yöntemlerinde zorunludur.

Parametre	Veri Tipi	Zorunluluk	Açıklama
flag	string(3)	Zorunlu	Haberleşme ünitesinin marka flag kodu.
serialNumber	string(15)	Zorunlu	Haberleşme ünitesinin 15 karakterli seri numarası