API Dokümantasyonu: Flow Oluşturma

Endpoint

POST /api/company/testcompany/flow/create

Başlıklar

Başlık Adı	Değer	Açıklama
Authorization	Bearer token	Kimlik doğrulama için gerekli
Content-Type	application/json	JSON formatında veri gönderilir
Accept	application/json	JSON formatında cevap beklenir

Request Body

{
  "subject": "İş sözleşmesi",  // Sözleşme veya anlaşma konusu
  "subjectDetail": "Q4 mali raporunun onayı",  // Konuya dair detaylar
  "externalObject": "EKKO25",  // Dış obje kimliği (örneğin proje veya dosya numarası)
  "externalObjectKey": "450000018",  // Dış obje ile ilişkili anahtar
  "externalId": "externalId-1-2-3",  // Dış obje kimliği (harici bir sisteme ait olabilir)
  "fromContactFullName": "Test test",  // Flow'u başlatan kişinin tam adı
  "defaultLanguage": "TR",  // İletişimde kullanılacak varsayılan dil (Türkçe)
  "signerList": [
    {
      "signerName": "John Doe Hasan",  // İlk imzalayan kişinin adı
      "signerIdNumber": "ID123456",  // TC (Türk Vatandaşı) numarası veya başka bir kimlik
      "signLevel": 1,  // İmza seviyesi (örneğin süreçte 1. seviye)
      "signMaxLevel": 3,  // Süreçteki maksimum imza seviyesi (3. seviye)
      "externalIdentification": "EXT_SIGN_002",  // Bu imzalayan için dış kimlik
      "email": "test2@snitechnology.net",  // Bildirimler için e-posta adresi
      "mobile": "+905452246232",  // Bildirimler için mobil numara
      "signerOrder": 1  // Bu kişinin imza sırası
    },
    {
      "signerName": "John Doe",  // İkinci imzalayan kişinin adı
      "signerIdNumber": "ID123456",  // TC numarası veya başka bir kimlik
      "signLevel": 1,  // İmza seviyesi
      "signMaxLevel": 3,  // Maksimum imza seviyesi
      "externalIdentification": "EXT_SIGN_001",  // Bu imzalayan için dış kimlik
      "email": "test2@snitechnology.net",  // E-posta adresi
      "mobile": "+905323944462",  // Mobil numara
      "signerOrder": 2  // İmza sırası
    }
  ]
}

Response (Örnek)

{
  "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)
    },
    {
      "messageClass": "esealer",  // Mesaj sınıfı
      "messageNumber": "009",  // Mesaj numarası
      "messageType": "SUCCESS",  // Mesaj tipi (INFO, ERROR, SUCCESS)
      "message": "Flow oluşturuldu",  // 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)
    }
  ]
}

Response Alanları

Alan	Tür	Açıklama
id	String	Flow için benzersiz kimlik
subject	String	Anlaşma veya sözleşme konusu
subjectDetail	String	Konuya dair detaylı açıklama
companyId	String	Şirket ID'si
externalObject	String	Dış obje kimliği
externalObjectKey	String	Dış obje anahtarı
externalId	String	Dış ID
flowStatus	String	Flow durumu (örneğin versiyon numarası)
flowStatusDescription	String	Flow durumu açıklaması
flowDocumentType	String	Flow için kullanılan belge türü
parallelSign	Boolean	Paralel imza özelliği açık mı
signatureType	String	İmza türü (örneğin PADES)
createDateTime	String	Flow'un oluşturulma tarihi ve saati
fromContactFullName	String	Flow'u başlatan kişinin adı
createdUser	String	Flow'u oluşturan kullanıcı
changedUser	String	Son olarak flow'u değiştiren kullanıcı
defaultLanguage	String	Flow için varsayılan dil (Türkçe)
signerList	Dizi	İmzalayanların sırasıyla detayları
processError	Boolean	Flow işlemesinde hata olup olmadığı
messages	Dizi	Flow ile ilgili mesajlar (durum, bilgi, vb.)

Notlar:

• signStatus her bir imzalayan için, imzalamanın durumunu belirtir (W = Bekliyor).
• messages dizisi, flow'un oluşturulma ve durum bilgileriyle ilgili mesajları içerir.

Sonuç

Bu API endpoint'i, bir anlaşma veya sözleşme için yeni bir flow oluşturmak için kullanılır. Konu, imzalayanlar ve belge türü gibi detayları içerir ve flow'un oluşturulma ve durumu izlenir.