Authentication

API servislerine authentication olmak ve token üretmek için kullanılacak servistir.

Servise gönderilmesi gereken parametreler şu şekildedir:

Parametre ismi	Tip	Uzunluk	Zorunluluk	Örnek Değer	Açıklama
username	string	50	Evet	kullanıcı adı	Sistemde kayıtlı kullanıcı adı
password	string	40	Evet	şifre	Sistemde kayıtlı şifre bilgisi

Servisten dönen parametreler şu şekildedir:

Parametre ismi	Tip	Uzunluk	Açıklama
isSuccess	boolean	--	true veya false döner. false ise işlem hata almıştır. true ise işlem başarılıdır.
errorCode	string	10	Başarısız olması durumunda hata kodu dolu gelecektir
message	string	2048	Cevap açıklaması. Başarılı durumunda "İşlem başarılıdır." mesajı dönecektir
data	data[]	--	Verinin doldurulduğu kısım
token	string	2048	Token bilgisi
userId	string	100	User Id bilgisi
expiration	Datetime	--	Token geçerlilik sona erme süresi
roleName	string	64	Üye işyeri rolü. "Uye Isyeri", "Aday Uye Isyeri"

Örnek JSON formatında istek ve cevaplar aşağıdadır:

HTTP Method: POST

Content-Type: application/json

URL: https://onboardingapi-test.birlesikodeme.com:30430/AuthMerchant/Login

*Test ortam için bu adresi kullanabilirsiniz. Prod ortam için size URL bilgisi entegrasyon sürecinde iletilecektir.

Request

{
  "username": "string",
  "password": "string"
}

Response

{
  "isSuccess": true,
  "errorCode": null,
  "message": "İşlem başarılıdır.",
  "data": {
    "token": "string",
    "userId": "string",
    "expiration": "2021-04-05T16:27:50.2412067Z",
    "roleName": "string"
  }
}

Gelen Token bilgisi diğer servisleri çağırırken Header’da kullanılacaktır. Authorization keyinin value kısmında bearer yazıp boşluk bırakıp authorization servisinden dönen token bilgisi eklenecektir.
Header: Key: Authorization Value: bearer ***