Factorizer/Cluster ERP WikiCluster ERP English
Ana sayfa / API referansı

API

Privacy API (privacy)

/api/v1/privacy altındaki privacy modülünün HTTP uç noktaları: yetkiler, şemalar, durum kodları ve hata kodlarıyla 11 yol.

privacy modülü doğrulama, dışa aktarma, anonimleştirme, tamamlama ve reddetme eylemleri ile dışa aktarım indirmesi içeren ilgili kişi taleplerini sunar. 11 uç noktanın tamamı /api/v1/privacy altındadır. İş anlamı için Privacy modülü sayfasına bakın.

Grup olguları

Öğe Değer Kaynak
Temel yol /api/v1/privacy src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/privacy/module.py:44
Yönlendiriciler 1 dosyada 1 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir src/cluster_erp/modules/privacy/module.py:41
Uç noktalar 11; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı src/cluster_erp/modules/privacy/requests/routes.py
Kimlik doğrulama Bearer başlığı veya oturum çerezi, get_current_user ile çözülür; bkz. Kimlik doğrulama ve başlıklar src/cluster_erp/modules/auth/guards.py:85-167
Yetki koruması 11 yolun 11 tanesi require_permission bildirir src/cluster_erp/modules/auth/guards.py:205-240
Hata biçimi JSON gövdesi {"error": {...}}; bkz. Hatalar src/cluster_erp/server/error_handler.py:33-46

Uç nokta özeti

Alt modül klasörü başına bir satır. Yönlendirici öneki temel yola eklenir.

Alt modül Yönlendiriciler Uç noktalar Yönlendirici kaynağı
requests router (/requests) 11 src/cluster_erp/modules/privacy/requests/routes.py:28

İlgili kişi talepleri uç noktaları

Talep kayıtları ve eylemleri.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/privacy/requests/ list_subject_requests subject_request.read yok search, status, request_type, party_id, limit, offset dict 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:39
GET /api/v1/privacy/requests/{request_id} get_subject_request subject_request.read yok yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:70
POST /api/v1/privacy/requests/ create_subject_request subject_request.create SubjectRequestCreate yok SubjectRequestRead 201 src/cluster_erp/modules/privacy/requests/routes.py:83
PUT /api/v1/privacy/requests/{request_id} update_subject_request subject_request.update SubjectRequestUpdate yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:96
DELETE /api/v1/privacy/requests/{request_id} delete_subject_request subject_request.delete yok yok yok 204 src/cluster_erp/modules/privacy/requests/routes.py:110
POST /api/v1/privacy/requests/{request_id}/actions/verify verify_identity subject_request.verify VerifyBody yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:125
POST /api/v1/privacy/requests/{request_id}/actions/export prepare_export subject_request.export yok yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:139
GET /api/v1/privacy/requests/{request_id}/export download_export subject_request.export yok yok Response 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:153
POST /api/v1/privacy/requests/{request_id}/actions/anonymise anonymise_subject subject_request.anonymise AnonymiseBody yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:175
POST /api/v1/privacy/requests/{request_id}/actions/complete complete_request subject_request.complete CompleteBody yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:190
POST /api/v1/privacy/requests/{request_id}/actions/reject reject_request subject_request.reject RejectBody yok SubjectRequestRead 200 (varsayılan) src/cluster_erp/modules/privacy/requests/routes.py:204

Hata kodları

Tablo, src/cluster_erp/modules/privacy/ altındaki kodun attığı hata kodlarını listeler. Kodlar, AppError(...) çağrıları, src/cluster_erp/core/errors.py içindeki fabrikalar (not_found, conflict, protected, permission_denied, privilege_escalation, check_version) ve HTTPException(...) için yapılan bir sözdizimi ağacı taramasıyla bulundu. 400 durumu AppError varsayılanıdır (src/cluster_erp/core/errors.py:23). Koruma hataları (401, 403), yetkilendirme kodları ve doğrulama hataları (422) her yol için geçerlidir ve Hatalar sayfasında listelenir.

Kod HTTP durumu Atıldığı yer İlk konum
CONCURRENCY_VERSION_CONFLICT 409 requests src/cluster_erp/modules/privacy/requests/services.py:176
PRIVACY_CONFIRMATION_MISMATCH 400 requests src/cluster_erp/modules/privacy/requests/services.py:308
PRIVACY_EXPORT_MISSING 404 requests src/cluster_erp/modules/privacy/requests/services.py:279
PRIVACY_INVALID_STATE 409 requests src/cluster_erp/modules/privacy/requests/services.py:86
RESOURCE_NOT_FOUND 404 requests src/cluster_erp/modules/privacy/requests/services.py:154

Yayımlanan olaylar

Tablo, src/cluster_erp/modules/privacy/ altındaki kodun EventBus.emit çağrısına doğrudan verdiği sözleşme sınıflarını listeler; sözdizimi ağacı taramasıyla bulundu. Önce bir değişkene kurulan olaylar sayılmaz. Sözleşmeler Sözleşmeler başvurusu sayfasında anlatılır.

Sözleşme Konum sayısı İlk konum
AnonymiseSubject 1 src/cluster_erp/modules/privacy/requests/services.py:345
CollectSubjectData 1 src/cluster_erp/modules/privacy/requests/services.py:223

İlgili sayfalar


92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.

Doğrulanan commit 92f8051 · 2026-11-13