Başlarken
Kimlik doğrulama ve sınırlar
Her istek, derginin API anahtarını X-Api-Key başlığında taşır. Geçerli anahtar olmayan istekler 401 ile reddedilir.
curl https://api.scholvet.com/v1/me \
-H "X-Api-Key: $SCHOLVET_API_KEY"Anahtar biçimi
Anahtar alt çizgiyle ayrılmış dört parçadan oluşur: sv, ortam (live ya da test), sekiz karakterlik anahtar kimliği ve gizli kısım. Scholvet anahtarın yalnızca özetini saklar; kaybolan anahtar yeniden gösterilemez, yenisiyle değiştirilir.
sv_live_7KQ2MX4P_9mX0t…
Anahtarı güvende tutmak
- API'yi yalnızca sunucunuzdan çağırın. Anahtarı tarayıcı koduna, mobil uygulamaya ya da herkese açık bir depoya koymayın.
- Anahtarları kaynak kodda değil, yapılandırmada ya da gizli anahtar deposunda tutun; loglara yazmayın.
- Bir anahtarın sızmış olabileceğini düşünüyorsanız konsoldan yenileyin. Eski anahtar hemen çalışmaz olur.
Birçok dergiyi barındıran sistemler
Her dergi için ayrı anahtar saklayın ve makalenin ait olduğu derginin anahtarını gönderin. Hakem kodları her dergide farklıdır; bir derginin gördüğü kod başka bir dergide kullanılamaz.
İstek sınırları
Her anahtar dakikada 120 istek gönderebilir. Sınır aşılırsa API 429 Too Many Requests döner; bir sonraki dakikayı bekleyip yeniden deneyin. Eksik ya da hatalı anahtarın yanıtı şöyledir:
HTTP/1.1 401 Unauthorized
Content-Type: application/problem+json
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": 401,
"detail": "API key is missing or invalid.",
"code": "invalid_api_key"
}