MevzuatRadar DokümantasyonRegTech API ve entegrasyon

OpenAPI ve Sözleşme Dosyaları

MevzuatRadar herkese açık API sözleşmesinin makine tarafından okunabilir kaynağı OpenAPI 3.0 çıktısıdır. Dokümantasyon, SDK kapsamı ve API referansı bu izin listesi üstünden eşleştirilir.

Sözleşme Kaynakları

KaynakKullanım
https://api.mevzuatradar.com/api/docs-jsonCanlı API tarafından servis edilen herkese açık OpenAPI JSON
apps/api/openapi.jsonRepo içindeki üretilmiş sözleşme ve güncellik guard girdisi
API referansı sayfalarıGeliştirici ekipleri için açıklamalı sözleşme

Entegrasyonu canlıya almadan önce test etme pratiği için Entegrasyon Testi sayfasını kullanın.

Herkese Açık Yol İzin Listesi

OpenAPI herkese açık izin listesi aşağıdaki yol ailelerini kapsar:

YolYöntem kapsamıKimlik doğrulama
/api/v1/public/source-statsGETYok
/api/v1/public/regulationsGETYok
/api/v1/changesGETx-api-key
/api/v1/deadlinesGETx-api-key
/api/v1/actionsGETx-api-key
/api/v1/verification-reportsGETx-api-key
/api/v1/verification-reports/{id}GETx-api-key
/api/v1/board-reportsGETx-api-key
/api/v1/board-reports/{id}GETx-api-key
/api/v1/evidence-packs/{id}GETx-api-key
/api/v1/webhooksGET, POSTBearer JWT
/api/v1/webhooks/{id}GET, PUT, DELETEBearer JWT
/api/v1/webhooks/{id}/testPOSTBearer JWT
/api/v1/webhooks/{id}/rotate-secretPOSTBearer JWT
/api/v1/webhooks/{id}/deliveriesGETBearer JWT

Bu listede olmayan endpointler herkese açık geliştirici sözleşmesi değildir.

Güncellik Komutları

npm run openapi:generate -w @mevzuat-radar/api
npm run openapi:check -w @mevzuat-radar/api

openapi:check, üretilmiş sözleşme ile repodaki apps/api/openapi.json arasında fark varsa başarısız olur. API referansı veya SDK değişikliği OpenAPI farkı kapatılmadan yayınlanmaz.

SDK Üretimi

Node.js ve Python SDK’ları herkese açık OpenAPI izin listesi ile aynı yol kapsamını kullanır. Paket kayıt sistemi erişimi müşteri sözleşmesi veya özel paket erişimiyle verilmediyse repo içi build/pack akışı kurulum alternatifi olarak kullanılır.