API Documentation: Example Service

Endpoint: Upload Files and Document Information

Request URL

/esealer-service/api/company/{{company_id}}/flow/{{flow_id}}/uploadFile

Açıklama

Bu API, belirtilen flow_id'ye sahip bir iş akışının durumunu alır. Bu API, belirtilen company_id'ye sahip bir iş akışının durumunu almak için kullanılır.

Başlıklar

Başlık Adı	Değer	Açıklama
Authorization	Bearer token	Kimlik doğrulama için gerekli

Request Parameters

1. files

• Description: Bu parametre, yüklemek için seçilen dosyaları içerir.
• Type: File
• Required: true
• Example:
  • files parametresi birden fazla dosya içerebilir.

2. documentDescription

• Description: Yüklenen belgenin açıklaması.
• Type: Text
• Required: true
• Example: "Açıklama örneği"

3. documentIdentification

• Description: Yüklenen belge için kimlik numarası.
• Type: Text
• Required: true (opsiyonel)
• Example: "DOC12345"

4. language (optional, default "EN")

• Description: API yanıtlarının döndüğü dil.
• Type: Text
• Required: false
• Default Value: EN
• Example: "TR", "EN"

---

Request Response

{
  "id": "1efb93ae-1505-641e-bf76-f3ad9dd2b290",  // Flow için benzersiz kimlik
  "subject": "İş sözleşmesi mail testi",  // Anlaşma veya sözleşme konusu
  "subjectDetail": "Q4 mali raporunun onayı",  // Konuya dair detaylı açıklama
  "companyId": "testcompany",  // Şirket ID'si
  "externalObject": "EKKO234",  // Dış obje kimliği
  "externalObjectKey": "450000018",  // Dış obje anahtarı
  "externalId": "externalId-1-2-3",  // Dış ID
  "flowStatus": "v11",  // Flow'un durumu (versiyon numarası)
  "flowStatusDescription": "Yaratıldı",  // Flow durumu açıklaması
  "flowDocumentType": "DEF",  // Flow için kullanılan belge türü
  "parallelSign": false,  // Paralel imza özelliği açık mı
  "signatureType": "PADES",  // İmza türü (örneğin PADES elektronik imza)
  "createDateTime": "2024-12-13T13:13:21.0574818",  // Flow'un oluşturulma tarihi ve saati
  "fromContactFullName": "Cem Dag",  // Flow'u başlatan kişinin adı
  "createdUser": "TESTUSER@SNI",  // Flow'u oluşturan kullanıcı
  "changedUser": "TESTUSER@SNI",  // Son olarak flow'u değiştiren kullanıcı
  "defaultLanguage": "TR",  // Flow için varsayılan dil (Türkçe)
  "signerList": [
    {
      "signLevel": 1,  // İmza seviyesi
      "signMaxLevel": 3,  // Maksimum imza seviyesi
      "isSigned": false,  // İmzalayan kişi imza atmış mı
      "signStatus": "W",  // İmza durumu (W = Bekliyor)
      "signStatusDescriptionWLangu": "Bekliyor",  // İmza durumu açıklaması (Türkçe)
      "externalIdentification": "EXT_SIGN_002",  // İmzalayan için dış kimlik
      "defaultLanguage": "TR"  // İmzalayan için varsayılan dil
    },
    {
      "signLevel": 1,  // İmza seviyesi
      "signMaxLevel": 3,  // Maksimum imza seviyesi
      "isSigned": false,  // İmzalayan kişi imza atmış mı
      "signStatus": "W",  // İmza durumu (W = Bekliyor)
      "signStatusDescriptionWLangu": "Bekliyor",  // İmza durumu açıklaması (Türkçe)
      "externalIdentification": "EXT_SIGN_001",  // İmzalayan için dış kimlik
      "defaultLanguage": "TR"  // İmzalayan için varsayılan dil
    }
  ],
  "processError": false,  // Flow işlemesinde hata olup olmadığı
  "messages": [
    {
      "messageClass": "esealer",  // Mesaj sınıfı
      "messageNumber": "008",  // Mesaj numarası
      "messageType": "INFO",  // Mesaj tipi (INFO, ERROR, SUCCESS)
      "message": "Kontroller tamamlandı. Hata yok",  // Mesaj içeriği
      "variable1": null,  // Ek değişken verisi (varsa)
      "variable2": null,  // Ek değişken verisi (varsa)
      "variable3": null,  // Ek değişken verisi (varsa)
      "variable4": null   // Ek değişken verisi (varsa)
    }
  ]
}