Başvuru

Hatalar ve sürümleme

Hatalar problem details biçimindedir (RFC 9457). HTTP durumunun yanında çoğu hatanın, programınızda kullanabileceğiniz kalıcı bir code değeri vardır; detail insanlar içindir ve değişebilir.

Örnek

HTTP/1.1 409 Conflict
Content-Type: application/problem+json

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.10",
  "title": "Conflict",
  "status": 409,
  "detail": "The reviewer was already invited for this article.",
  "code": "reviewer_unavailable"
}

Hata kodları

HTTP	code	Anlamı
400	—	Gövde geçerli JSON değil ya da bir alan kurala uymuyor. errors alanları listeler.
401	`invalid_api_key`	API anahtarı eksik, hatalı ya da devre dışı.
402	`overage_cap_reached`	Kurumunuzun aşım üst sınırı doldu; bu dönem yeni davet gönderilemez.
403	`account_suspended`	Kurum hesabı askıya alındı. Scholvet ile iletişime geçin.
403	`account_pending`	Kurum hesabı doğrulama bekliyor: aramalar çalışır (dergi başına günde en fazla 100); davet ve hakem kaydı henüz yapılamaz.
429	`pending_search_limit`	Doğrulama bekleyen hesaplar için günlük arama sınırı. Hesap etkinleşince kalkar.
404	`search_not_found`	Arama yok ya da başka bir dergiye ait.
404	`invitation_not_found`	Davet yok ya da başka bir dergiye ait.
409	`search_expired`	Arama 30 günden eski. Yeniden arayın.
409	`reviewer_unavailable`	Hakem bu makale için zaten davet edilmiş ya da artık müsait değil (kapasite, izin ya da yeni bir çıkar çatışması).
409	`invalid_status`	İşlem davetin mevcut durumunda yapılamaz.
422	`reviewer_not_in_search`	Hakem kodu o aramanın sonuçları arasında değil.
429	—	Bu anahtarla bir dakikada 120'den fazla istek.
5xx	—	Bizim tarafımızda bir sorun. Aynı isteği daha sonra yeniden deneyin.

Doğrulama hatası

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Keywords": ["The field Keywords must be a string or array type with a minimum length of '1'."]
  }
}

Sürümleme

v1 içinde yanıtlara alan eklenebilir ama alan hiçbir zaman silinmez ya da yeniden adlandırılmaz. Tanımadığınız alanları yok sayın.
Yeni olay türleri ve status ile declineReason için yeni değerler gelebilir. Bilinmeyen değerleri sorunsuz karşılayın.
Kırıcı bir değişiklik /api/v2 olarak yayımlanır. v1 çalışmaya devam eder; kaldırılmadan çok önce haber verilir.

OpenAPI tanımı

İstemci üretmek ve test araçları için v1'in makinece okunabilir tanımı: https://api.scholvet.com/openapi/v1.json

Hakem verisini işlemek

Hakem kodlarını ve skorları yayın sisteminizin içinde tutun. Yazarlara göstermeyin.
Hakemin kimliği kabul ettiği değerlendirme için sizinle paylaşılır. Yalnızca o değerlendirme ve derginizin yayın işleri için kullanın.
Kodları dergiler arasında eşleştirmeye ya da arama sonuçlarından hakemleri tanımaya çalışmayın.
Her arama, davet ve karar, onu yapan anahtarla birlikte Scholvet'te kayıt altındadır.