gettransactionhashforonlinehelp

POST v1/application/gettransactionhashforonlinehelp#

Bu API mobil uygulamanız üzerinden canlı yardım işlemi başlatabilmek için kullanılır. Mobil uygulamanızda Diylog sdk içerisinden Diyalog deviceHash ve müşteri numarasını kendi uygulama sunucunuza göndermelisiniz. Bu bilgiler ile uygulama sunucunuz üzerinden bu api çağırmalı ve anlık olarak bu müşteri ve cihaz için bir transactionHash oluşturup alabilirsiniz. Bu transactionHash bilgisini daha sonra mobil uygulamanızdan canlı yardım başlatabilmek için mobil uygulamanıza geri dönmelisiniz.

API istekleri

HMAC Authentication ile doğrulanmalıdır. HMAC Authentication için Authentication dokümanına bakınız.
API URI : https://DIYALOG-SERVER-API-ENDPOINT/v1/application/gettransactionhashforonlinehelp
HTTP İstek Türü POST
HTTP Content-Type application/json

Request Body#

Schema
json object
customerId (String) Canlı yardım başlatmak istediğiniz müşteri numarası
deviceHash (String) Canlı yardım başlatacağınız mobil cihazdan DiyalogSDK'nın getDeviceHash metodu ile aldığınız Diyalog deiveceHash bilgisidir. Bu bilgi her cihaz için tekil bir bilgidir.

Örnek Json Request Body :#

{
    "customerId" : "123456",
    "deviceHash" : "fwCZgi6zl2DPuNck6H644eq6JfPZpXKCqa2ouP2JS+k="
}

Responses#

HTTP 200 Response
json object API cevap olarak json object döner. Bu json object içerisinde transactionHAsh oluşturma işleminin sonucu ve transactionHash bilgisi döner.
isSuccess (boolean) transactionHash bilgisinin başarı ile oluşturulup oluşturulamadığını döner. Eğer false değer döner ise transactionHash oluşturulamamış demektir. Neden oluşmadığı ile ilgili mesajı aşağıdaki message parametresinden alabilirsiniz.
message (string) İşlem sonucu ile ilgili sonuç metnini döner. İşlem başarısız ise hata mesajını bu alandan görebilirsiniz.
transactionHash (string) Kendisine parametre olarak iletilen müşteri ve deviceHash için oluşturulan transactionHash bilgsidir. Bu bilgi ile mobil uygulamanız üzerinden canlı yardım başlatabilirsiniz.

Örnek Response Body :#

{
    "isSuccess": true,
    "message": "TransactionHash created",
    "transactionHash": "7c5963043b37edbe2706c2b48b4568387084acc7"
}

HTTP 500 Response
string API exception aldığında HTTP 500 status kodu ile cevap dönecektir. API'nin hata mesajı metin olarak döner.

API isteği doğrulama sırasında hata alırsa aşağıdaki hata kodlarını döner.#

Http Status Code	Mesaj	Açıklama
400	Required headers not found	Date, X-Requester-UserId veya X-Authorization header alanlarından biri veya birkaçı eksik.
400	Authorization failed due to data format not valid	X-Authorization header alanındaki bilgiler doğru formatta değil. Alanın "DLGA " ile başlayıp accesKeyId ve imza değerleri arasına : olduğunu kontrol edin.
400	Authorization failed due to date not valid	X-DLG-DATE tarih formatı "EEE, dd MMM yyyy HH:mm:ss Z" formatında değil. Kontrol edin..
401	Authorization failed	İstek doğrulanamadı. İmza değeri doğru değil.
403	Request time may not be correct.	İstek header'ında gelen x-dlg-date ve sunucu zamanı arasında +/- 15 dakikadan fazla fark var.