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

Hızlı Başlangıç

MevzuatRadar, resmî kaynaklardaki yayınları toplar; mevzuat takibi, sınıflandırma, özetleme ve bildirim akışlarını destekler. Entegrasyona başlamak için önce müşteri hesabı açılır, ardından kurumun planı ve kullanıcının yetkileri uygunsa API anahtarı oluşturulur.

1. Hesap oluşturma ve giriş

  1. Kayıt sayfasında  ad, e-posta, telefon ve kurum bilgileri girilir. Kayıt formu şifre istemez.
  2. Normal kayıtta e-posta ve telefon ayrı ayrı tek kullanımlık kodla (OTP) doğrulanır. Davet bağlantısıyla kayıtta e-posta doğrulaması davetten karşılanır; telefon OTP doğrulaması yine gerekir.
  3. Kayıt tamamlanınca uygulama oturumu başlatılır ve sunucunun belirlediği sonraki adıma geçilir. İlk kurulum gereken hesaplarda bu yol /setup olur.
  4. Sonraki girişler müşteri giriş sayfasından  e-posta bağlantısı veya koduyla ya da telefon OTP’siyle yapılır. E-posta bağlantısının kullanılabilirliği kurumun etkinleştirme politikasına bağlıdır.

Platform yönetimi ayrı yönetim adresindedir . Kurum yöneticisi olmak platform yönetimine erişim sağlamaz. OTP, magic link ve JWT alma sözleşmeleri Kimlik Doğrulama sayfasındadır.

2. API anahtarı oluşturma

  1. Kurumun ADMIN rolündeki kullanıcı API ayarlarını  açar.
  2. Yeni API Anahtarı formunda ad ve gereken izinler seçilir. İlk okuma isteği için regulations:read yeterlidir. Genel API erişimi ve anahtar sayısı plan ve ek haklarla sınırlıdır.
  3. İsteğe bağlı son kullanma tarihi ve izinli IP listesi belirlenir.
  4. Yalnız oluşturma veya yenileme yanıtında gösterilen anahtar güvenli sır yöneticisine kaydedilir. Gerçek anahtar dokümana, kaynak koduna veya log’a yazılmaz.

Anahtar yönetiminin API karşılığı POST /api/v1/api-keys yoludur; API anahtarı ile değil, ADMIN rolü ve settings:write izni olan JWT oturumuyla çağrılır. İstek alanları ve yenileme işlemleri Kimlik Doğrulama sayfasında açıklanır.

3. İlk okuma isteği

Aşağıdaki değişken, oluşturulan gerçek anahtarı güvenli ortamdan alır:

curl -sS "https://api.mevzuatradar.com/api/v1/changes?limit=20" \ -H "x-api-key: $MEVZUATRADAR_API_KEY"

Bu yol kurum bağlamında çalışır. page varsayılanı 1, limit varsayılanı 20, izin verilen limit aralığı 1–100 değerleridir. Başarılı yanıt { success: true, data: { items, total, page, limit, totalPages } } biçimindedir; kayıtlar data.items altında bulunur.

Kimlik doğrulamasız deneme için ayrı bir açık arşiv yolu vardır:

curl -sS "https://api.mevzuatradar.com/api/v1/public/regulations?limit=10"

Açık arşiv, kuruma özel değişiklik akışıyla aynı sözleşme değildir; bu yolda varsayılan limit 10, üst sınır 20 değeridir. İlgili sözleşmeler Mevzuat Değişiklikleri ve Herkese Açık Mevzuat Arşivi sayfalarındadır.

4. Webhook ve SDK ile devam etme

Webhook yönetimi ADMIN rolü, JWT oturumu ve işleme göre settings:read / settings:write sayfa izni ister. API anahtarındaki webhooks:manage katalog izni bu oturum koşulunun yerine geçmez. POST /api/v1/webhooks isteğinde url ve events alanları zorunludur; NEW_REGULATION desteklenen olaylardan biridir. İstek ve imza doğrulama örnekleri Webhook Akışı sayfasındadır.

Depoda Node.js istemcisi packages/sdk-node, Python istemcisi packages/sdk-python altında bulunur. Paket kurulumu ve kullanım örnekleri Node.js Örnek İstemcisi ve Python Örnek İstemcisi bölümündedir. Depoda paket bulunması, bir paket sicilinde herkese açık yayımlandığı anlamına gelmez.

İzole deneme, yerel kurulum ve canlı API kullanımı arasındaki ayrım Yerel Geliştirme ve Entegrasyon Testi sayfasındadır.