Genel Tanıtım

Giriş

Bu bölüm ile amaçlanan, harici otomasyon sistem geliştiricilerinin, genel bir bakış açısı ile sistem mimarisi, iş akışları, sistemler arasında paylaşılan veri içeriklerini, sistem bileşenlerini tanıyıp geliştirmeye geçmeden önce sistemi tanımasıdır.

Harici otomasyon geliştiricileri, sistemi tanıdıktan sonra geliştirme sürecini geliştirici dokümanı syafasından devam edecektir. Token template uygulaması kodlarını inceleyerek, kendi sistemine Token integration hub DLL i ekleyerek Token OKC ile hızlıca entegre olacaktır.

Mimari

Protokol ve İş Akışları

Geliştirici dokümanında detaylarını bulabileceğiniz Token Integration hub DLL aşağıda özetle anlattığmız akışların hepsini geliştiriciler adına yapmaktadır.

1. Get Fiscal Parameters: Harici sistem ile Token OKC nin mali olarak eşleşmesi için zorunlu adımdır bu adım sonunda cihaz mali numarası, cihazın içinde kayıltı ürünler ve kısımlar PC'ye aktarılır.

2. Send Basket ( 300TR & X30TR)

   1. Kendi sisteminiz de Token Integration Protocol ile oluşturduğunuz sepetinizi iletiniz.

      1. Sepet

      2. Ödeme yöntemini talebi (KK, Nakit gibi)

   2. Kendi sisteminizde callback yapısı ile sonuç beklenir.

   3. Token OKC platformunda Ödeme ve Mali işlemler çalışır.

   4. Token Integration temel protokolü sonuç içeriği aktarılır:

      1. Ödeme bilgileri (Ödeme türü, Varsa BKM ID, Tutar )

      2. Fiş bilgileri (Fiş no, Z no, Ekü no)

      3. Fatura bilgileri (UUID,)

3. Hata Ayıklama: İletişimde çıkan herhangi bir hata yine callback yapısı ile sizin sisteminiz tarafından takip edilebilir. Hatalardan haberdar olarak sisteminizde aksiyon alabilirsiniz.

4. Güvenlik:

   1. Güvenlikle alaklı şemamız aşağıda verilmişitr. TLV protokolünün nasıl kullandığımızla alaklı daha detaylı bilgi DLL dokumantasyonunda bulunmaktadır.

      

Token entegrasyon temel protokolü

Aşağıda gördüğünüz Json formatları iletişim protokolümüzün temelini oluşturmaktadır detaylı Json yapıları ve kütüphane özellikleri için "Token Integration Hub DLL" kısımına bakınız.

// Send Basket
{
  "basketID": "93ced0be-99f5-4e42-b0ca-bc781c778d69",
  "createInvoice": false,
  "documentType": 0,
  "isVoid": false,
  "items": [
    {
      "name": "GIDA",
      "price": 500,
      "sectionNo": 1,
      "taxPercent": 1000,
      "type": 0,
      "limit": 0,
      "quantity": 1000
    },
    {
      "barcode": "",
      "name": "Armut",
      "pluNo": 0,
      "price": 1500,
      "sectionNo": 1,
      "taxPercent": 1000,
      "type": 0,
      "limit": 0,
      "quantity": 1000
    }
  ],
  "adjust": {
    "description": "20 tl indirim",
    "discountOrSurcharge": 0,
    "type": 0,
    "value": 2000
  }
}

// Basket Result

//Successful sale
{
  "basketID": "93ced0be-99f5-4e42-b0ca-bc781c778d69",
  "documentType": 0,
  "InstanceIdentifier": "XXXX",
  "invoiceID": "",
  "message": "OK",
  "paymentCount": 1,
  "paymentItems": [
    {
      "amount": 2000,
      "BatchNo": 0,
      "currencyId": 0,
      "description": "Nakit",
      "operatorId": 0,
      "status": -1,
      "TxnNo": 0,
      "type": 1
    }
  ],
  "receiptNo": 2,
  "status": 0,
  "UUID": "aa2c8046-f0bd-4617-9f5d-0bb6eb4f4ed7",
  "zNo": 12
}

//Unsuccessful sale
{
  "basketID":"93ced0be-99f5-4e42-b0ca-bc781c778d69",
  "message":"CANCELLED",
  "status":-1
}

Token entegrasyon Demosu

Bu kısa video da Token entegrasyon hub DLL i kullananan, Token template (şablon) uygulması ile Token OKC nin nasıl çalıştığını görebilirsiniz.

Geliştirmeye başlamak

Hızlı başlangıç sayfasına geçerek, Token Template simulatoru açık kaynak kodları ile nasıl kuracağınızı, Token entegrasyon hub DLL'i nasıl kurup nasıl kullanacağınızın detaylarını bulacaksanız.