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

API

Parties API (parties)

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

parties modülü tarafları ve fotoğraflarını, adresleri, iletişim kanallarını ve kanal türlerini, kişi dillerini ve ülkeler, adres seviyeleri ve adres seviyesi değerleri için başvuru verilerini sunar. 53 uç noktanın tamamı /api/v1/parties altındadır. İş anlamı için Parties modülü sayfasına bakın.

Grup olguları

Öğe Değer Kaynak
Temel yol /api/v1/parties src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/parties/module.py:96
Yönlendiriciler 5 dosyada 5 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir src/cluster_erp/modules/parties/module.py:76
Uç noktalar 53; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı src/cluster_erp/modules/parties/addresses/routes.py, src/cluster_erp/modules/parties/communication_channels/routes.py, src/cluster_erp/modules/parties/parties/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ı 53 yolun 53 tanesi require_permission bildirir src/cluster_erp/modules/auth/guards.py:205-240
Uygulama yetkilendirme kapısı bağlanan her yönlendiricide require_app("parties") src/cluster_erp/modules/parties/module.py:103
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ğı
settings router (/settings) 18 src/cluster_erp/modules/parties/settings/routes.py:30
parties router 9 src/cluster_erp/modules/parties/parties/routes.py:28
addresses router 7 src/cluster_erp/modules/parties/addresses/routes.py:21
communication_channels router 13 src/cluster_erp/modules/parties/communication_channels/routes.py:27
person_languages router 6 src/cluster_erp/modules/parties/person_languages/routes.py:19

Ülkeler ve adres seviyeleri uç noktaları

Ülkeler (internetten güncelleme ve adres seviyesi tohumlamasıyla), adres seviyeleri ve adres seviyesi değerleri.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/parties/settings/countries/ list_countries country.read yok active_only list[CountryRead] 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:38
POST /api/v1/parties/settings/countries/update-from-internet update_countries_from_internet country.create yok yok dict 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:55
POST /api/v1/parties/settings/countries/ create_country country.create CountryCreate yok CountryRead 201 src/cluster_erp/modules/parties/settings/routes.py:65
GET /api/v1/parties/settings/countries/{country_id} get_country country.read yok yok CountryRead 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:79
PUT /api/v1/parties/settings/countries/{country_id} update_country country.update CountryUpdate yok CountryRead 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:92
POST /api/v1/parties/settings/countries/bulk-delete bulk_delete_countries country.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:106
DELETE /api/v1/parties/settings/countries/{country_id} delete_country country.delete yok yok yok 204 src/cluster_erp/modules/parties/settings/routes.py:117
POST /api/v1/parties/settings/countries/{country_id}/seed-address-levels seed_address_levels country.seed yok yok dict 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:133
GET /api/v1/parties/settings/countries/{country_id}/address-levels list_address_levels address_level.read yok yok list[AddressLevelRead] 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:154
POST /api/v1/parties/settings/address-levels create_address_level address_level.create AddressLevelCreate yok AddressLevelRead 201 src/cluster_erp/modules/parties/settings/routes.py:171
PUT /api/v1/parties/settings/address-levels/{level_id} update_address_level address_level.update AddressLevelUpdate yok AddressLevelRead 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:182
POST /api/v1/parties/settings/address-levels/bulk-delete bulk_delete_address_levels address_level.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:196
DELETE /api/v1/parties/settings/address-levels/{level_id} delete_address_level address_level.delete yok yok yok 204 src/cluster_erp/modules/parties/settings/routes.py:207
GET /api/v1/parties/settings/address-levels/{level_id}/values list_address_level_values address_level_value.read yok parent_id list[AddressLevelValueRead] 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:223
POST /api/v1/parties/settings/address-level-values create_address_level_value address_level_value.create AddressLevelValueCreate yok AddressLevelValueRead 201 src/cluster_erp/modules/parties/settings/routes.py:238
PUT /api/v1/parties/settings/address-level-values/{value_id} update_address_level_value address_level_value.update AddressLevelValueUpdate yok AddressLevelValueRead 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:249
POST /api/v1/parties/settings/address-level-values/bulk-delete bulk_delete_address_level_values address_level_value.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/settings/routes.py:266
DELETE /api/v1/parties/settings/address-level-values/{value_id} delete_address_level_value address_level_value.delete yok yok yok 204 src/cluster_erp/modules/parties/settings/routes.py:277

Taraflar uç noktaları

Taraf kayıtları ve taraf fotoğrafı. Yönlendiricinin öneki yoktur; taraf yolları doğrudan modül temel yolunun altındadır.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/parties/ list_parties party.read yok search, party_type, role, active_only, limit, offset dict 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:37
POST /api/v1/parties/ create_party party.create PartyCreate yok PartyRead 201 src/cluster_erp/modules/parties/parties/routes.py:70
GET /api/v1/parties/{party_id} get_party party.read yok yok PartyRead 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:88
PUT /api/v1/parties/{party_id} update_party party.update PartyUpdate yok PartyRead 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:105
POST /api/v1/parties/bulk-delete bulk_delete_parties party.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:123
DELETE /api/v1/parties/{party_id} delete_party party.delete yok yok yok 204 src/cluster_erp/modules/parties/parties/routes.py:135
GET /api/v1/parties/{party_id}/photo get_party_photo party.read yok yok Response 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:161
POST /api/v1/parties/{party_id}/photo set_party_photo party.update çok parçalı file yok PartyRead 200 (varsayılan) src/cluster_erp/modules/parties/parties/routes.py:187
DELETE /api/v1/parties/{party_id}/photo delete_party_photo party.update yok yok yok 204 src/cluster_erp/modules/parties/parties/routes.py:233

Adresler uç noktaları

Bir tarafın adresleri ve tüm adreslerin listesi.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/parties/addresses/all list_all_addresses address.read yok search, limit, offset, party_id, address_type dict 200 (varsayılan) src/cluster_erp/modules/parties/addresses/routes.py:29
GET /api/v1/parties/{party_id}/addresses list_addresses address.read yok search list[AddressRead] 200 (varsayılan) src/cluster_erp/modules/parties/addresses/routes.py:92
POST /api/v1/parties/{party_id}/addresses create_address address.create AddressCreate yok AddressRead 201 src/cluster_erp/modules/parties/addresses/routes.py:104
GET /api/v1/parties/addresses/{address_id} get_address address.read yok yok AddressRead 200 (varsayılan) src/cluster_erp/modules/parties/addresses/routes.py:119
PUT /api/v1/parties/addresses/{address_id} update_address address.update AddressUpdate yok AddressRead 200 (varsayılan) src/cluster_erp/modules/parties/addresses/routes.py:132
POST /api/v1/parties/addresses/bulk-delete bulk_delete_addresses address.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/addresses/routes.py:146
DELETE /api/v1/parties/addresses/{address_id} delete_address address.delete yok yok yok 204 src/cluster_erp/modules/parties/addresses/routes.py:157

İletişim kanalları uç noktaları

Varsayılan tohumlamalı kanal türleri, bir tarafın kanalları ve tüm kanalların listesi.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
POST /api/v1/parties/settings/channel-types/seed-defaults seed_channel_type_defaults channel_type.seed yok yok dict 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:35
GET /api/v1/parties/settings/channel-types/ list_channel_types channel_type.read yok active_only list[ChannelTypeRead] 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:44
POST /api/v1/parties/settings/channel-types/ create_channel_type channel_type.create ChannelTypeCreate yok ChannelTypeRead 201 src/cluster_erp/modules/parties/communication_channels/routes.py:61
PUT /api/v1/parties/settings/channel-types/{type_id} update_channel_type channel_type.update ChannelTypeUpdate yok ChannelTypeRead 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:72
POST /api/v1/parties/settings/channel-types/bulk-delete bulk_delete_channel_types channel_type.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:86
DELETE /api/v1/parties/settings/channel-types/{type_id} delete_channel_type channel_type.delete yok yok yok 204 src/cluster_erp/modules/parties/communication_channels/routes.py:97
GET /api/v1/parties/channels/all list_all_channels channel.read yok search, limit, offset dict 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:113
GET /api/v1/parties/{party_id}/channels list_channels channel.read yok yok list[CommunicationChannelRead] 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:158
POST /api/v1/parties/{party_id}/channels create_channel channel.create CommunicationChannelCreate yok CommunicationChannelRead 201 src/cluster_erp/modules/parties/communication_channels/routes.py:169
GET /api/v1/parties/channels/{channel_id} get_channel channel.read yok yok CommunicationChannelRead 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:184
PUT /api/v1/parties/channels/{channel_id} update_channel channel.update CommunicationChannelUpdate yok CommunicationChannelRead 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:197
POST /api/v1/parties/channels/bulk-delete bulk_delete_channels channel.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/communication_channels/routes.py:214
DELETE /api/v1/parties/channels/{channel_id} delete_channel channel.delete yok yok yok 204 src/cluster_erp/modules/parties/communication_channels/routes.py:225

Kişi dilleri uç noktaları

Bir kişi tarafının dilleri.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/parties/{party_id}/languages list_languages person_language.read yok yok list[PersonLanguageRead] 200 (varsayılan) src/cluster_erp/modules/parties/person_languages/routes.py:22
POST /api/v1/parties/{party_id}/languages create_language person_language.create PersonLanguageCreate yok PersonLanguageRead 201 src/cluster_erp/modules/parties/person_languages/routes.py:33
GET /api/v1/parties/languages/{language_id} get_language_row person_language.read yok yok PersonLanguageRead 200 (varsayılan) src/cluster_erp/modules/parties/person_languages/routes.py:45
PUT /api/v1/parties/languages/{language_id} update_language person_language.update PersonLanguageUpdate yok PersonLanguageRead 200 (varsayılan) src/cluster_erp/modules/parties/person_languages/routes.py:58
POST /api/v1/parties/languages/bulk-delete bulk_delete_languages person_language.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/parties/person_languages/routes.py:72
DELETE /api/v1/parties/languages/{language_id} delete_language person_language.delete yok yok yok 204 src/cluster_erp/modules/parties/person_languages/routes.py:83

Hata kodları

Tablo, src/cluster_erp/modules/parties/ 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
RESOURCE_CONFLICT 409 settings src/cluster_erp/modules/parties/settings/routes.py:74
RESOURCE_NOT_FOUND 404 addresses, communication_channels, parties, person_languages, settings src/cluster_erp/modules/parties/addresses/routes.py:115
VALIDATION_ERROR 400 parties src/cluster_erp/modules/parties/parties/routes.py:198

Yayımlanan olaylar

Tablo, src/cluster_erp/modules/parties/ 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
PartyCreated 1 src/cluster_erp/modules/parties/parties/services.py:156
PartyDeleted 2 src/cluster_erp/modules/parties/parties/services.py:222
PartyUpdated 1 src/cluster_erp/modules/parties/parties/services.py:202

İlgili sayfalar

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

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