İçeriğe Geç

Mevzuat Bülteni (Dönem Özeti)

GET /api/v1/library/digest

Mevzuat Bülteni (Dönem Özeti)

Belirli bir tarih penceresinde yayımlanan regülasyonların özet listesini tek çağrıda döner. Kendi bülteninizi, haftalık raporunuzu veya "bu ay ne çıktı" ekranınızı beslemek için tasarlanmıştır — sayfa sayfa /library gezmeye gerek kalmaz.

Zorunlu tarih penceresi

  • publishedSince — pencere başlangıcı (ISO 8601). Zorunlu.
  • publishedUntil — pencere bitişi (ISO 8601). Zorunlu. Bitiş günü tümüyle dâhildir.

İkisinden biri eksikse veya tarih olarak ayrıştırılamıyorsa uç nokta 400 VALIDATION_ERROR döner (aşağıdaki source kuralı da aynı hatayı üretir).

Pencereye iki düzeltme uygulanır ve ikisi de hata vermez, sessizce çalışır:

  • Ters pencere takas edilir. publishedUntil publishedSince'ten önceyse iki uç yer değiştirir.
  • Pencere en fazla 366 gündür. Daha genişini isterseniz başlangıç kırpılır: publishedUntil'dan geriye 366 gün alınır. Yani çok geniş bir aralık gönderdiğinizde eksik veri değil, beklediğinizden dar bir pencere alırsınız.

Diğer parametreler

  • institutionType — virgülle ayrılmış InstitutionType sayı değerleri, örn. 1,4. (Gezinme ucundaki tekil sayı davranışından farklıdır.)
  • topic — virgülle ayrılmış TopicType sayı değerleri, örn. 3,9.
  • source — virgülle ayrılmış kaynak id'leri (uuid). Id'leri GET /library/sources döner. Belge, listelenen kaynaklardan herhangi biri tarafından yayımlanmışsa bültene girer. En fazla 100 id.
  • maxResults — 1-500 arasına kırpılır; varsayılan 200.

Filtreler birbirine VE ile bağlanır: institutionType=4&source=… yalnızca o kaynağın 4 etiketli belgelerini döner.

institutionType ve topic etiket süzgeçleridir: hiç etiketi olmayan bir belge, bu süzgeçlerden biri gönderildiğinde — bütün değerleri listeleseniz bile — dönmez. Dönemde yayımlanan her şeyi istiyorsanız ikisini de göndermeyin.

İkisini birlikte gönderdiğinizde, yapay zekânın iki boyuttan birinde hiç etiket vermediği belge o boyut yüzünden elenmez:

  • Kurum türü etiketlerinden biri listenizde olan ve hiç konu etiketi olmayan belge döner (güvenden bağımsız). Yapay zekâ, sektöre yönelik bir düzenlemede uygun konu bulamadığında konu etiketi vermez.
  • Hiç kurum türü etiketi olmayan belge, konu etiketlerinden biri listenizde ve o etiketin güveni en az 0,6 ise döner. Yapay zekâ kurum türünü yalnızca finansal sektöre yönelik metinlere verir; vergi, kişisel veri ya da iş hukuku düzenlemeleri bu yüzden yalnızca konu etiketi taşır.
  • İki boyutta da etiketi olan belge iki süzgece de uymalıdır; iki boyutta da etiketi olmayan belge dönmez.

Süzgeçlerden yalnızca birini gönderdiğinizde bu kural uygulanmaz: belge o süzgece uymalıdır.

Ayrıştırılamayan bir sayı (institutionType, topic) listeden sessizce düşer. source bunun istisnasıdır: geçersiz bir uuid veya 100'ü aşan liste 400 VALIDATION_ERROR döner — tek kaynak id'nizdeki bir yazım hatası sessizce düşseydi, "yalnızca SPK" isteğiniz "tüm kaynaklar" yanıtına dönüşürdü.

Yanıt

  • windowStart / windowEnd — yukarıdaki düzeltmeler uygulandıktan sonra fiilen kullanılan pencere. Gönderdiğiniz değerlerden farklı olabilir; ekranda tarih aralığı gösteriyorsanız bu iki alanı kullanın.
  • totalCount — süzgeçlere uyan toplam kayıt sayısı (maxResults'tan bağımsız).
  • windowTotalCount — aynı pencerede ve aynı source süzgeciyle, institutionType / topic uygulanmadan yayımlanan belge sayısı. Bu iki süzgeç yalnızca yapay zekânın etiketlediği belgeleri getirir ve belgelerin çoğu etiket taşımaz (yükümlülük çıkarılmamıştır); bu yüzden totalCount çoğu zaman windowTotalCount'tan çok küçüktür. Ekranınızda "67 belgeden 4'ü süzgecinize uyuyor" diyebilmeniz içindir. İki etiket süzgeci de gönderilmediyse totalCount'a eşittir.
  • truncated — toplam sonuç maxResults'ı aşıyorsa true. Bu durumda pencereyi daraltın veya maxResults'ı yükseltin.
  • items[] — her kayıt: id, title, publishedDate, sourceUrl, sourceName, sourceShortCode, summary ve institutionTypes (okunabilir etiketler).
  • updates[] — pencerede içeriği değişen belgeler (yayımlananlar değil): items[] ile aynı alanlar, artı updatedAt (değişikliğin algılandığı an, UTC) ve revisionNumber. Aynı institutionType / topic / source süzgeçleri uygulanır; en son değişen önce, en fazla maxResults kayıt. Bazı kurumlar (ör. TCMB) mevzuatı aynı adreste, yayım tarihi vermeden günceller; bu belgeler items[]'a hiç giremez — publishedDate alanları çoğu zaman null'dur. Pencere günleri burada Türkiye saatiyle yorumlanır. Aynı pencerede yayımlanmış bir belge yalnızca items[]'ta yer alır. Farkın kendisi için GET /library/{id}/changes kullanın.

Kayıtlar yayım tarihine göre yeniden eskiye sıralı döner. sourceName / sourceShortCode alanları /library gezinme yanıtında yoktur — bu uç noktaya özeldir, ayrıca bir id→ad haritası kurmanız gerekmez.

Yürürlük süzgeci

Bülten yalnızca yürürlükteki mevzuatı içerir; mülga belgeler hiçbir koşulda dönmez ve bunu kapatan bir parametre yoktur. Mülga mevzuata erişmek için GET /library?legalStatus=all kullanın.

Yetki ve kota

Api.Library.Browse iznini gerektirir ve gezinme uç noktasıyla aynı kota kovasından düşer.

Aynı mevzuatın ikinci resmî nüshası (ikiz) listelerde ve sayımlarda yer almaz; detay ucu canonicalDocumentId ile sahibine işaret eder.

Parametreler

İsimKonumTipZorunluAçıklama
publishedSince Query date-time Evet Pencere başlangıcı (ISO 8601). Zorunlu.
publishedUntil Query date-time Evet Pencere bitişi (ISO 8601). Zorunlu; bitiş günü tümüyle dâhildir.
institutionType Query string Hayır Virgülle ayrılmış InstitutionType sayı değerleri, örn. '1,4'. (Gezinme ucundaki tekil sayı davranışından farklıdır.)
topic Query string Hayır Virgülle ayrılmış TopicType sayı değerleri, örn. '3,9'.
source Query string Hayır Virgülle ayrılmış kaynak id'leri (uuid, bkz. /library/sources); belgeyi yayımlayan kaynaklardan herhangi birine göre süzer. En fazla 100 id. Geçersiz bir id sessizce düşmez, 400 döner.
maxResults Query integer Hayır 1-500 arasına kırpılır; varsayılan 200.

Yanıtlar

200 — windowStart, windowEnd, totalCount, windowTotalCount (institutionType/topic süzgeçleri uygulanmadan penceredeki belge sayısı), truncated, items[] ve updates[] (dönemde İÇERİĞİ değişen belgeler: items alanları + updatedAt, revisionNumber) (id, title, publishedDate, sourceUrl, sourceName, sourceShortCode, summary, institutionTypes). Pencere 366 günle sınırlıdır (aşılırsa publishedUntil'dan geriye 366 gün alınır); publishedUntil < publishedSince ise iki uç yer değiştirir. Mülga mevzuat bu uçtan hiçbir zaman dönmez.

400 — publishedSince/publishedUntil eksik veya ayrıştırılamadı; ya da source geçersiz bir uuid ya da 100'den fazla id içeriyor (VALIDATION_ERROR).