Ana içeriğe geç
Mevzuat RadarDokümantasyon
Uygulamaya git ↗

Yönetim Kurulu Raporları API

HTTP yöntemiYolİşlev
GET/api/v1/board-reportsOrganizasyonun raporlarını listeler
GET/api/v1/board-reports/:idTek raporun detayını döndürür

Bu yollar mevcut raporları okur; rapor üretimi başlatmaz. Liste createdAt azalan sıralanır. Liste ve detay sorguları sunucuda çözülen organizasyon kimliğiyle sınırlandırılır; başka organizasyonun raporu detayda 404 döner.

Kimlik Doğrulama ve Yetki

Kimlik doğrulamaKural
API anahtarıx-api-key; reports:read izni gerekir. Bu izin anahtar oluşturma veya izin güncelleme sırasında yalnız ENTERPRISE planına verilir
JWTAuthorization: Bearer <JWT>; yalnız ADMIN veya EDITOR rolü kabul edilir
Plan ve kotaAnahtar çağrısında publicApi özelliği ve planın hız sınırı; hem JWT hem anahtar çağrısında genel API kullanım kotası denetlenir

JWT yolunda ayrıca bir ENTERPRISE plan kontrolü tanımlı değildir. API anahtarı için izin verme politikası, JWT rol kontrolüyle aynı kural değildir. Geçerli abonelik ve kullanılabilir kota gerekir.

Sorgu ve Yol Parametreleri

Liste sorgusunun bütün alanları isteğe bağlıdır:

ParametreTip ve doğrulamaVarsayılan
pageTam sayı, en az 11
limitTam sayı, 1–5020

Detay yolundaki id mevcut raporun metin kimliğidir; controller UUID biçimi zorunlu tutmaz. Tanımlanmamış liste sorgusu alanları 400 döner.

Yanıt

Her iki işlem başarıda 200 döner. Liste zarfı:

{ "success": true, "data": { "items": [], "page": 1, "limit": 20, "total": 0, "totalPages": 1 } }

Detayda data tek rapor nesnesidir. Liste satırı ve detay aynı alanları taşır:

AlanTip / anlam
id, titleMetin
periodStart, periodEnd, createdAtISO 8601 tarih-saat
periodTypeMONTHLY, QUARTERLY, YEARLY, CUSTOM
sectionsMetin dizisi
formatPDF veya EXCEL
statusGENERATING, COMPLETED, FAILED
fileKeyDepolama anahtarı veya null; doğrudan indirme URL’si değildir
downloadUrlİmzalı dosya URL’si veya null
lowQualityCount, highQualityCountSayısal kayıt sayıları
lowQualityAppendix{ regulationId, title, sourceType, impactLevel, qualityScore } dizisi
readinessSummaryHazırlık özeti nesnesi veya null
verificationAppendixDoğrulama eki nesnesi veya null
createdBy{ id, name, email } veya null

downloadUrl yalnız status=COMPLETED ve dosya anahtarı dolu olduğunda üretilir; imzalama başarısızsa yine null olur. İmzalı bağlantı için 3600 saniyelik geçerlilik istenir. Dosya format alanına göre PDF veya Excel olabilir; her bağlantı PDF değildir.

readinessSummary; generatedAt, regulationChangeSummary, openEvidenceGaps, overdueActions, unsignedMandatoryReads, trustRiskSummary, missingEvidenceCount, articleImpactLinks alanlarını taşır. verificationAppendix; generatedAt, runs, results, exports alanlarını taşır. Bu alanların varlığı dış denetim veya sertifika onayı değildir.

Boş listede totalPages=1; diğer durumlarda ceil(total / limit) olur.

Hata Kodları

HTTP durumuAnlam
400Geçersiz liste sorgusu veya sayfalama
401JWT/API anahtarı eksik veya geçersiz
402Genel API kotası çözülürken abonelik bağlamı bulunamıyor
403JWT rolü, anahtar/IP izni, plan özelliği veya kullanım kotası yetersiz
404Detay raporu bulunamadı veya organizasyon kapsamında değil
429İstek hızı aşıldı; mevcutsa Retry-After süresine uyulur
503API anahtarının hız sınırı denetimi kullanılamıyor

Hatalar application/problem+json türünde döner. Ortak alanlar Ortak API Kuralları sayfasındadır.

Örnekler

curl --fail-with-body 'https://api.mevzuatradar.com/api/v1/board-reports?limit=10' \ -H "x-api-key: $MEVZUATRADAR_API_KEY"

Listedeki id değeriyle detay okunur:

curl --fail-with-body "https://api.mevzuatradar.com/api/v1/board-reports/$REPORT_ID" \ -H "Authorization: Bearer $MEVZUATRADAR_JWT"

Kişisel alan izni

API anahtarıyla createdBy kişi bilgisini (id, ad ve e-posta) almak için people:read izni gerekir. İzin yoksa createdBy alanı yanıtta hiç bulunmaz; null yer tutucu dönmez. JWT yanıtı değişmez. Yeni anahtarlarda bu izin açıkça seçilir.