API

Kullanım ve kota

Paketler tek bir dergiye değil kurum hesabına aittir. Bir kurumun tüm dergileri, kabul edilen davetlerden oluşan tek bir yıllık kotayı paylaşır.

Ne sayılır

Aramalar, istek sınırı dışında ücretsiz ve sınırsızdır.
Bir birim, hakemin kabul ettiği bir davettir. Reddedilen, süresi dolan ve geri çekilen davetler sayılmaz.
Dahil kotanın ötesinde her kabul edilen davet aşım olarak faturalanır. Kota tek başına işinizi hiçbir zaman durdurmaz.
Kurumunuz konsolda bir aşım üst sınırı koyarsa, sınır dolduğunda yeni davetler reddedilir.

GET /v1/usage

Anahtarın ait olduğu kurum hesabının bu dönemki kotasını döndürür.

İstek

curl https://api.scholvet.com/v1/usage \
  -H "X-Api-Key: $SCHOLVET_API_KEY"

Yanıt gövdesi

Alan	Tür	Açıklama
`plan`	`string \| null`	Paket anahtarı; hesap etkinleşmeden önce null.
`periodStart`	`date-time \| null`	Bu dönemin başlangıcı.
`periodEnd`	`date-time \| null`	Bu dönemin sonu (dahil değil).
`included` zorunlu	`integer`	Pakete dahil kabul edilen davet sayısı.
`used` zorunlu	`integer`	Dönemdeki kabul edilen davetler; hesabın tüm dergileri.
`remaining` zorunlu	`integer`	Kalan dahil davet.
`overage` zorunlu	`integer`	Kotayı aşan, aşım olarak faturalanan kabul edilen davetler.
`overageCap`	`integer \| null`	Kurumun koyduğu aşım üst sınırı; yoksa null.
`capReached` zorunlu	`boolean`	Sınır dolmuş ve yeni davetler reddediliyorsa true.
`usedByThisJournal` zorunlu	`integer`	Bu anahtarın ait olduğu derginin kabul edilen davetleri.
`credits` zorunlu	`integer`	Bu dönemde verilen ağ kredisi. Dahil olana eklenir: kalan = dahil + kredi − kullanılan.

Yanıt

{
  "plan": "standard",
  "periodStart": "2026-01-01T00:00:00Z",
  "periodEnd": "2027-01-01T00:00:00Z",
  "included": 200,
  "used": 214,
  "remaining": 0,
  "overage": 8,
  "overageCap": 50,
  "capReached": false,
  "usedByThisJournal": 37,
  "credits": 6
}

Ağ kredisi

Dergilerinizden birinin eklediği hakem (POST /v1/reviewers ya da yazarların önerdiği hakem) başka bir kurumun dergisinin davetini kabul ettiğinde hesabınıza kredi olarak bir kabul edilmiş davet eklenir; hakem başına en fazla beş. Kredi verildiği dönemde geçerlidir, sonraki döneme aktarılmaz. Kendi eklediğiniz hakemleri davet etmek kredi kazandırmaz.

Sınır dolduğunda

Davet oluşturma 402 ve overage_cap_reached koduyla yanıt verir. Aramalar ve diğer her şey çalışmaya devam eder. Hesap sahibi sınırı konsoldan yükseltebilir.

Yanıt

HTTP/1.1 402 Payment Required
Content-Type: application/problem+json

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.3",
  "title": "Payment Required",
  "status": 402,
  "detail": "The overage cap your institution set for this period is reached. Raise it in the console or wait for the next period.",
  "code": "overage_cap_reached"
}

Sonraki: Webhook'lar →