İşlem Akışları API
GET /api/v1/actions
Aktif organizasyonun silinmemiş aksiyonlarını listeler. Bu uç nokta okuma
içindir; aksiyon oluşturmaz veya güncellemez. Organizasyon kimliği sunucuda
kimlik doğrulama bağlamından çözülür; sorguda organizationId kabul edilmez.
Kimlik Doğrulama ve Yetki
| Alan | Kural |
|---|---|
| API anahtarı | x-api-key başlığında geçerli anahtar; actions:read izni gerekir |
| JWT | Authorization: Bearer <JWT>; actions sayfası için okuma izni denetlenir |
| JWT kayıt kapsamı | ADMIN, EDITOR, LEGAL_REVIEWER organizasyon listesini; VIEWER yalnız kendisine atanmış aksiyonları görür |
| API anahtarı kayıt kapsamı | Anahtarın organizasyonu; kullanıcıya atanma filtresi uygulanmaz |
| Plan ve kota | API anahtarı erişimi için publicApi özelliği ve desteklenen plan gerekir; varsayılan plan kodları PROFESSIONAL, COMMERCIAL, ENTERPRISE olur. JWT ve anahtar çağrıları genel API kullanım kotasını tüketir |
API anahtarı izni ile JWT sayfa izni farklı denetimlerdir. Plan limitleri ve abonelik durumu için İstek Limitleri ve Planlar sayfası kullanılır.
Sorgu Parametreleri
Bütün parametreler isteğe bağlıdır. Tanımlanmamış sorgu alanları 400 döner.
| Parametre | Tip ve doğrulama | Varsayılan / anlam |
|---|---|---|
page | Tam sayı, en az 1 | 1 |
limit | Tam sayı, 1–100 | 20 |
status | PENDING, IN_PROGRESS, COMPLETED, OVERDUE, CANCELLED | Verilmezse durum filtresi yok |
priority | LOW, MEDIUM, HIGH, CRITICAL | Verilmezse öncelik filtresi yok |
dueDateFrom | ISO 8601 tarih metni | Vade için alt sınır; sınır dahil |
dueDateTo | ISO 8601 tarih metni | Vade için üst sınır; sınır dahil |
OPEN bir aksiyon durumu değildir. Tarih sınırı verilmezse vadesi olmayan
aksiyonlar da listelenebilir. Tarih aralığının başlangıç/bitiş sırası için
ayrı DTO doğrulaması yoktur. Sıralama dueDate artan, ardından createdAt
azalan şeklindedir; istemci bir sıralama parametresi göndermez.
Yanıt
Başarı durumu 200 olur. Yanıt zarfı aşağıdaki yapıdadır:
{
"success": true,
"data": {
"items": [],
"total": 0,
"page": 1,
"limit": 20,
"totalPages": 0
}
}data.items[] alanı | Tip / anlam |
|---|---|
id, title | Metin; aksiyon kimliği ve başlığı |
description | Metin veya null |
priority, status | Yukarıdaki enum değerleri |
dueDate | ISO 8601 tarih-saat veya null |
regulationId | İlişkili mevzuat kimliği |
department | Departman metni veya null |
assignee | { id, name, email } veya null |
createdAt, updatedAt | ISO 8601 tarih-saat |
Sayfalama alanları data içindedir; ayrı bir meta nesnesi yoktur.
totalPages, sonuç yokken 0, diğer durumlarda ceil(total / limit) olur.
Hata Kodları
Hatalar application/problem+json türünde, RFC 9457 alanları ve geriye uyumlu
success: false, error, statusCode, path alanlarıyla döner.
| HTTP durumu | Anlam |
|---|---|
400 | Geçersiz sorgu, enum veya sınır dışı sayfalama |
401 | JWT/API anahtarı eksik, geçersiz veya süresi dolmuş |
402 | Genel API kotası çözülürken abonelik bağlamı bulunamıyor |
403 | Anahtar izni, JWT sayfa izni, kaynak IP izni, plan özelliği veya kullanım kotası yetersiz |
429 | İstek hızı aşıldı; mevcutsa Retry-After süresine uyulur |
503 | API anahtarının hız sınırı denetimi kullanılamıyor |
Ortak hata alanları için Ortak API Kuralları
sayfası kullanılır. PLAN_LIMIT_REACHED gibi mesaj önekleri her zaman aynı
isimde bir errorCode alanı anlamına gelmez.
Örnekler
curl --fail-with-body --get 'https://api.mevzuatradar.com/api/v1/actions' \
--data-urlencode 'status=PENDING' \
--data-urlencode 'limit=20' \
-H "x-api-key: $MEVZUATRADAR_API_KEY"JWT ile aynı URL çağrılırken başlık
Authorization: Bearer <JWT> olarak gönderilir.
Kişisel alan izni
API anahtarıyla assignee kişi bilgisini (id, ad ve e-posta) almak için
people:read izni gerekir. İzin yoksa assignee 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.