API Dokümanları
BAŞLANGIÇ
Servislere erişim sağlanması için öncelikle Token alınması gerekmektedir. Token
alınması için aşağıdaki 2 metottan biri kullanılabilir.
Servis Swagger Adresi :
https://restapi.ttmesaj.com/swagger/index.html
1. /api/Login/TokenJson
API erişimi için token alınmalıdır. Json formatıyla token almak için bu metodu kullanmalısınız. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz.
https://restapi.ttmesaj.com/api/Login/TokenJson
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| userName | string | TT Mesaj tarafından verilen API Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | TT Mesaj tarafından verilen API Şifre bilgisidir. Zorunlu bir alandır. | ||
Json Request örneği aşağıdaki gibidir:
{
"userName": "xxxx",
"password": "xxxx"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama | |
|---|---|---|---|
| access_token | string | Token bilgisi string olarak servisten gönderilir. Diğer metotlara erişmek için önce token almalısınız. | |
| token_type | string | Token dönüş tipidir. Alandan sadece “bearer” tipi gelir. | |
| expires_in | int | Token’ın geçerlilik süresidir. Alanda, saniye cinsinden dönüş yapılır. Token geçerlilik süresi 1 gündür. | |
Json Response örneği aşağıdaki gibidir:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8y
MDA1LzA1L2lkZW50aXR5L2Nsc4OSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo1MjIyLyIsImF1ZCI6Imh
0dHA6Ly9sb2NhbGhvc3Q6NTIyMi8ifQ.kgMhFXGrg5nUmVpYcWisH0njvZ_bkL7SKiGu8XafrVE",
"token_type": "bearer",
"expires_in": 86400
}
2. /ttmesajToken
API erişimi için token alınmalıdır. Form-encoded formatıyla token almak için bu metodu kullanmalısınız. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz.
https://restapi.ttmesaj.com/ttmesajToken
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| grant_type | string | Sabit olarak “password” değeri gönderilmelidir. | ||
| userName | string | TT Mesaj tarafından verilen API Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | TT Mesaj tarafından verilen API Şifre bilgisidir. Zorunlu bir alandır. | ||
Request örneği aşağıdaki gibidir:
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama | |
|---|---|---|---|
| access_token | string | Token bilgisi string olarak servisten gönderilir. Diğer metotlara erişmek için önce token almalısınız. | |
| token_type | string | Token dönüş tipidir. Alandan sadece “bearer” tipi gelir. | |
| expires_in | int | Token’ın geçerlilik süresidir. Alanda, saniye cinsinden dönüş yapılır. Token geçerlilik süresi 1 gündür. | |
Json Response örneği aşağıdaki gibidir:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8y
MDA1LzA1L2lkZWTcwNTEyNDc4OSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo1MjIyLyIsImF1ZCI6Imh
0dHA6Ly9sb2NhbGhvc3Q6NTIyMi8ifQ.kgMhFXGrg5nUmVpYcWisH0njvZ_bkL7SKiGu8XafrVE",
"token_type": "bearer",
"expires_in": 86400
}