Skip to main content

Document Upload

Belge yükleme işlemleri için kullanılan endpoint'ler.


Belge Yükle

Sisteme yeni bir belge yükler.

Authentication
  • x-auth (tenant-id)
HTTP Request

POST /document/upload-document

Request Parameters
FieldTypeRequiredDefaultDesc
base64Datastringtrue-Base64 formatında dosya içeriği
fileNamestringtrue-Dosya adı
descriptionstringtrue-Belge açıklaması
fileNameJsonobjectfalse-Çoklu dil desteği için JSON formatında dosya adı
descriptionJsonobjectfalse-Çoklu dil desteği için JSON formatında açıklama
Request Body Example
{
"base64Data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA...",
"fileName": "kimlik_belgesi.png",
"description": "Kimlik belgesi ön yüz"
}
Response Parameters
FieldTypeNullableDesc
dataobjecttrueBelge metadata bilgileri
Response Body Example
{
"userId": "123",
"identityNo": "12345678901",
"name": "kimlik_belgesi.png",
"mimeType": "image/png",
"type": 1,
"description": "Kimlik belgesi ön yüz",
"status": "active",
"reason": "waitingApproval",
"filePath": "documents/123e4567/kimlik_belgesi.png"
}

Kullanıcı Belgelerini Getir

Kullanıcıya ait belgeleri listeler.

Authentication
  • x-auth (tenant-id)
HTTP Request

GET /user/get-documents

Request Parameters
FieldTypeRequiredDefaultDesc
userIdstringfalse-Kullanıcı ID (filtreleme)
typestringfalse-Belge tipi
statusstringfalse-Belge durumu
reasonstringfalse-Belge sebebi
Response Parameters
FieldTypeNullableDesc
idstringfalseBelge ID
userIdstringfalseKullanıcı ID
namestringfalseDosya adı
mimeTypestringfalseDosya MIME tipi
typenumberfalseBelge tipi kodu
descriptionstringtrueBelge açıklaması
statusstringfalseBelge durumu
reasonstringtrueDurum sebebi
filePathstringfalseDosya yolu
createdAtdatefalseOluşturulma tarihi

Admin - Belge Kaydet

Admin tarafından kullanıcıya belge kaydeder.

Authentication
  • x-auth (tenant-id)
HTTP Request

POST /admin/save-document

Request Parameters
FieldTypeRequiredDefaultDesc
userIdstringtrue-Belge sahibi kullanıcı ID
base64Stringstringtrue-Base64 formatında dosya içeriği
documentNamestringtrue-Belge adı
typestringtrue-Belge tipi
descriptionstringfalse-Belge açıklaması
descriptionJsonobjectfalse-Çoklu dil açıklaması
nameJsonobjectfalse-Çoklu dil belge adı
Request Body Example
{
"userId": "123",
"base64String": "data:application/pdf;base64,JVBERi0xLjQK...",
"documentName": "sozlesme.pdf",
"type": "contract",
"description": "Kullanıcı sözleşmesi"
}

Kullanıcı Belgesi Güncelle

Mevcut bir belgeyi günceller.

Authentication
  • x-auth (tenant-id)
HTTP Request

POST /user/update-document

Request Parameters
FieldTypeRequiredDefaultDesc
idstringtrue-Belge ID
userIdstringtrue-Kullanıcı ID
descriptionstringfalse-Yeni açıklama
descriptionJsonobjectfalse-Çoklu dil açıklaması
statusstringfalse-Yeni belge durumu
reasonstringfalse-Durum değişiklik sebebi

Admin - Belge Dosyasını Getir

Belge dosyasının içeriğini getirir.

Authentication
  • x-auth (tenant-id)
HTTP Request

GET /admin/get-document-file

Request Parameters
FieldTypeRequiredDefaultDesc
documentInfoobjecttrue-Belge bilgisi
Response Parameters

Belge dosyası binary formatında döner.