3. Bağlantı Kur

Fiziksel Pos bağlantısı kurmak için bu servis üzerinden alabilirsiniz

POST {{Base Address}}/api/connection

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

Önemli: Bağlantı Kur servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PhysicalAPI Adresi

Servise gönderilmesi gereken header bilgileri şu şekildedir:

ParametreTipZorunluAçıklama

apikeyprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Key.

apiclientprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Client.

Servise gönderilmesi gereken body bilgileri şu şekildedir:

{
  "BrandId": 10,
  "ProviderId": 20,
  "RegionId": 1,
  "EndOfDayId": 1,
  "DisplayName": "Uygulama İsmi",
  "IsProd": true,
  "IsReporting": true,
  "IsAsyncPayment": true,
  "IsSocketPayment": true,
  "ServiceParameters": {
    "Key1": "Value", // Key, listeleme anında döner
    "Key2": "Value", // Key, listeleme anında döner
    "Key3": "Value", // Key, listeleme anında döner
    "Key4": "Value" // Key, listeleme anında döner
  },
  "Name": "Bağlantı İsmi"
}
ParametreTipZorunluUzunlukAçıklama
BrandId

int

Evet

-

Bkz: Marka

ProviderId

int

Evet

-

Bkz: Sağlayıcı

RegionId

int

Evet

-

Bkz: Ülke/Bölge

EndOfDayId

int

Evet

-

Bkz: Valör Günü

DisplayName

string

Hayır

25

Pos cihazlarının ekranlarında uygulama ismi vb gösterilmesi gereken durumlarda bu bilgi kullanılmaktadır

IsProd

bool

Evet

-

Bağlantının Canlı/Test olduğunu ifade eder

IsReporting

bool

Evet

-

Bağlantı raporlama özelliğini desteklesin mi?

IsAsyncPayment

bool

Evet

-

Bağlantı asenkron ödeme yöntemini desteklesin mi?

IsSocketPayment

bool

Evet

-

Bağlantı socket alt yapısında ödeme yöntemini desteklesin mi?

ServiceParameters

Dictionary<string, string>

Evet

-

Bağlantı kurmak istediğiniz sağlayıcı (Papara vb) hangi parametreleri alıyorsa, key-value olarak iletilmelidir

Name

string

Evet

100

Bağlantınıza verdiğiniz özel isim

Servisten dönen cevap:

ParametreTipAçılama

Result

object

Servisin detayındaki bilgileri döner

ErrorCode

int

Hata kodu. İşlem başarılı ise '0' değerini döner.

Succeeded

bool

True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner

Failed

bool

True ya da false değeri döner. İşlem başarısız iste 'true' değerini döner

Message

string

İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.

ClientMessage

string

Paywall hata kodlarının sabit değerlerini döner. Map'leme yapabilirsiniz

{
    "result": {
        "status": true
    },
    "failed": false,
    "message": null,
    "clientMessage": null,
    "succeeded": true
}

Last updated