Magic Link ile Kimlik Doğrulama
Bu endpoint, geleneksel bir şifre olmadan giriş yapmak için kullanılabilecek güvenli bir magic link oluşturmanıza olanak tanır. Link belirli bir süre (3 dakika) aktif kalır ve kullanıcı dostu bir deneyim sunar.
HTTP İstek Detayları
- Yöntem:
POST
- URL:
https://api.vinter.me/api/v1/Auth/CreateMagicLink
İstek Başlıkları
Başlık Adı | Açıklama | Örnek Değer |
---|---|---|
X-Api-Key | Organizasyon kimlik doğrulama API anahtarı. | api_key |
X-User-Secret-Key | Kullanıcı kimlik doğrulama kullanıcı anahtarı. | user_secret_key |
Content-Type | İstek gövdesinin medya tipini belirtir. | application/json |
İstek Gövdesi
İstek gövdesinde şu alanlar yer almalıdır:
Parametre Adı | Tür | Gerekli | Açıklama |
---|---|---|---|
firstName | String | Evet | Kullanıcının adı. |
lastName | String | Evet | Kullanıcının soyadı. |
email | String | Evet | Kullanıcının e-posta adresi. |
phone | String | Evet | Kullanıcının telefon numarası. |
languageCode | String | Evet | İletişim için tercih edilen dil. |
mailPermission | Boolean | Evet | E-posta bildirimleri alma izni. |
Örnek İstek Gövdesi
{
"firstName": "Kaan",
"lastName": "KIVIRCIK",
"email": "[email protected]",
"phone": "+905555555555",
"languageCode": "tr-TR",
"mailPermission": true
}
İlk Yanıt Formatı
İlk istek sonucunda, yeni bir SecretKey
ve MagicLink
döndürülür. Bu MagicLink
3 dakika boyunca geçerlidir. Aynı SecretKey
ile yapılan sonraki isteklerde yeni bir anahtar döndürülmez, ancak geçerli bir magic link döndürülmeye devam eder.
Örnek Yanıt Gövdesi (İlk İstek)
{
"Data": {
"SecretKey": "cHXjfI+7gOLBuqAbd62OHA==:OGSrEIkyrzen4IoTsoL8j0OUe0l/Ho3e+kCxRiYZbha1fsrh8UHpFTH7bBdBRiRhEBydIK2UhvbmZm1Osmb3tMz0AYtep+0CTOwecZd5YstURjbKNyll3hvil0vvr4VUjWnatYds5jH6EumUcnkSaswsBV2nH/EGIBLkiTcwjm3CJ5/ZFD+By3AsaXNIhC+eTKmQT8er3ArvW6otZusBsZm7pUWvuxOgheVXpxEU8mz6Ft/fiTNHp8KJLF6U1crP",
"MagicLink": "https://api.vinter.me/loginWithKey?apiKey=BFflidn6j2yTh7ul2pLmpw==:wQLz9jG/T0j6nNHfMCnBMJrekhDaYj6TG5lQ+ikHDcyXcbODkg0wo8wmaFt6isAyzjQWxpRS7P569Cz/GT7sDBKSLy1O03Hca/aaR9ilY20znmDtDCeSGoIm0qUf88s9M+NDQJ0EiF37A+wxmUSj0Es2LZgsvvUVgQzxRvqZnTUzLuD6FRvUV0SGyFkdWN5udZPcbRD3g3ilrtc/60BKhGsK1R81ogCO/pUj7RAH6cNkcbShtLry/4f5+fMRi6NQ"
},
"Success": true,
"Message": null,
"IsResourceKey": true
}
Sonraki Yanıt Formatı
Aynı SecretKey
ile yapılan sonraki isteklerde SecretKey
alanı null olacaktır. Dönen MagicLink
ise yine 3 dakika geçerli olacaktır.
Örnek Yanıt Gövdesi (Sonraki İstek)
{
"Data": {
"SecretKey": null,
"MagicLink": "https://api.vinter.me/loginWithKey?apiKey=BFflidn6j2yTh7ul2pLmpw==:wQLz9jG/T0j6nNHfMCnBMJrekhDaYj6TG5lQ+ikHDcyXcbODkg0wo8wmaFt6isAyzjQWxpRS7P569Cz/GT7sDBKSLy1O03Hca/aaR9ilY20znmDtDCeSGoIm0qUf88s9M+NDQJ0EiF37A+wxmUSj0Es2LZgsvvUVgQzxRvqZnTUzLuD6FRvUV0SGyFkdWN5udZPcbRD3g3ilrtc/60BKhGsK1R81ogCO/pUj7RAH6cNkcbShtLry/4f5+fMRi6NQ"
},
"Success": true,
"Message": null,
"IsResourceKey": true
}
Detaylı Alan Açıklamaları
-
SecretKey:
İlk istek sırasında üretilen benzersiz anahtar. Yeni bir secret key oluşturmadan sonraki isteklerde header alanında kullanılmalıdır. -
MagicLink:
Giriş yapmak için kullanılabilecek güvenli bir link. 3 dakika geçerlidir. -
Success:
İsteğin başarıyla işlenip işlenmediğini belirtir. -
Message:
Ek bilgi veya hata mesajları. -
IsResourceKey:
Yanıtın kaynak anahtarı içerip içermediğini belirten bir bayrak.
Kullanım Alanları
-
Şifresiz Giriş:
Kullanıcılara, şifreleri hatırlamalarına gerek kalmadan hızlı ve güvenli bir giriş yöntemi sunar. -
Güvenli Erişim Kontrolü:
Sadece yetkili kişilerin geçerli bir magic link oluşturmasını sağlar. -
Kolaylaştırılmış Kayıt Süreci:
Yeni kullanıcılar, geleneksel kayıt süreçlerine gerek kalmadan hesaplarını kolayca oluşturup giriş yapabilir.