Light Logo

İzin Yönetim

İzin yönetimi API metodları ile firmanız için SMS_OTP ve SINGLE_OPT_IN yöntemi ile KVKK Aydınlatma, KVKK'ya ilişkin açık rıza ve pazarlama izinlerini yönetebilirsiniz.

Hangi yöntemi kullanmanız gerektiği konusunda lütfen danışmanlarımızdan destek alınız. İzin alma seneryonuzu destek@dijiizin.com'a ilettiğiniz taktirde uzmanlarımız dönüş yapacaktır.

DOUBLE_OPT_IN

İzin İşlemi Başlatma
İzin İşlemi Onaylama

SINGLE_OPT_IN

İzin Alma

İzin İşlemi Başlatma - DOUBLE_OPT_IN

Endpoint URL

POST
https://api.dijiizin.com/api/V3/double-opt-in/consent

Açıklama

Bu method ile SMS_OTP yöntemi ile izin alma işlemi başlatılabilir. Başarılı gerçekleşen istek sonrasında, 10 dakika içerisinde İzin İşlemi Onaylama işlemi gerçekleştirilmelidir. Aksi taktirde bu endpointe yeni istek göndererek yeni izin alma işlemi başlatılmalıdır. İzin işlemi başlatıldıktan sonra 1 ile 180 saniye arasında Girilen telefon numarasına ONAY SMS’i içerisinde 2 adet kod ve hukuki metinler gönderilecektir.

Parametreler

  • Name
    Environment
    Required State
    zorunlu
    Format
    string
    Description

    İznin hangi elektronik ortamda alındığını belirtir. Zorunlu değerler: HS_EORTAM, HS_WEB, HS_MOBIL, HS_MESAJ, HS_EPOSTA, HS_CAGRI_MERKEZI, HS_SOSYAL_MEDYA Değerlerinden biri seçilmelidir.

  • Name
    ConsentTime
    Required State
    zorunlu
    Format
    date d-m-Y H:i:s
    Description

    İznin alındığı tarihi ifade eder. `DD-MM-YYYY HH:mm:ss``formatıdna olmalıdır. Örn: 27-12-2022 02:25:12

  • Name
    Description
    Required State
    zorunlu
    Format
    string
    Description

    İzin alma sırasında gönderilen açıklama alanıdır.

  • Name
    Url
    Required State
    opsiyonel
    Format
    string
    Description

    İzin alma işleminin başladığı bağlantı adresidir. Eğer izin alma işlemi bir web sayfası üzerinde başlatılıyorsa gönderilmesi gereklidir

  • Name
    PersonalInfo
    Description

    PersonalInfo'nun istek içerisinde yer alması zorunludur. Ad Soyad alanı mutlaka doldurulmalıdır. Alınacak izinlere göre Phone ve Email alanlarından birini doldurmak yeterli olabilir.

  • Name
    PersonalInfo.Phone
    Required State
    opsiyonel zorunlu
    Format
    string
    Description

    ContactConsents bölümünde Sms veya Call izinleri “ONAY” durumunda gönderildiğinde doldurulması zorunludur. Başında 0 oladan 10 haneli olarak gönderilmelidir.

  • Name
    PersonalInfo.Email
    Required State
    opsiyonel zorunlu
    Format
    string
    Description

    ContactConsents bölümünde Email “ONAY” durumunda gönderildiğinde doldurulması zorunludur. E-posta formatına uygun olarak gönderilmelidir.

  • Name
    DocumentConsents.KVKK
    Required State
    zorunlu
    Description

    Kişinin kaydedilecek KVKK izinlerini ifade eder. İçerisinde dijiizin’den alacağınız KVKK metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır.

  • Name
    DocumentConsents.RIZA
    Required State
    zorunlu
    Description

    Kişinin kaydedilecek KVKK’ya ait açık rıza izinlerini ifade eder. İçerisinde dijiizin’den alacağınız Açık Rıza metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır.

  • Name
    ContactConsents
    Required State
    zorunlu
    Description

    Eğer kişiye ilişkin pazarlama izinlerini almak istiyorsanız ContactConsent parametresi gönderilmelidir.

  • Name
    ContactConsents.Type
    Required State
    zorunlu
    Format
    string
    Description

    İznin ticari veya bireysel olup olmadığını ifade eder. Ticari izinler için TACIR bireysel izinler için BIREYSEL olarak değer gönderilmelidir. ContactConsents parametresi gönderildiği taktirde bu alanın gönderilmesi zorunludur.

  • Name
    ContactConsents.Sms
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin MESAJ pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. SMS pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.Call
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin ARAMA pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. ARAMA pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.Email
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin EPOSTA pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. EPOSTA pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.ETK
    Required State
    opsiyonel zorunlu
    Description

    Kişinin kaydedilecek ETK’ya ait açık rıza izinlerini ifade eder. İçerisinde dijiizin’den alacağınız ETK metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır. ContactConsents parametresi gönderildiği taktirde bu alanın gönderilmesi zorunludur.

  • Name
    BranchAccess
    Required State
    opsiyonel
    Description

    Kişiye ve izinlerine erişim izni vereceğiniz şubeleri ifade eder. İstek gövdesinde yer alması zorunlu değildir. İletildiğinde dizi olarak BranchId değerleri gönderilmelidir. BranchId değerleri gönderildiğinde, Firma ana yetklisi dışında sadece gönderilen BranchId değerine karşılık gelen şubenin kullanıcıları bu kişiye erişim sağlayabilecektir.

Authorization

   Authentication: Bearer <jeton>

Örnek Request

POST
https://api.dijiizin.com/api/V3/double-opt-in/consent
{
  "Environment": "HS_EORTAM",
  "PersonalInfo": {
    "Name": "Ad",
    "Surname": "Soyad",
    "Phone": "5360000000",
    "Email": "destek@dijiizin.com"
  },
  "ConsentTime": "27-12-2022 02:25:12",
  "Description": "Bu izin demowebsite.com üzerinden yeni üyelik sırasında ile alındı",
  "Url": "dijiizin.com/yeni-uyelik",
  "DocumentConsents": {
    "KVKK": {
      "DocumentId": 6004,
      "DocumentUrl": "https://demowebsite.com/kvkk"
    },
    "RIZA": {
      "DocumentId": 6001,
      "DocumentUrl": "http://demowebsite.com/acikriza"
    }
  },
  "ContactConsents": {
    "Type": "BIREYSEL",
    "Sms": "ONAY",
    "Call": "ONAY",
    "Email": "ONAY",
    "ETK": {
      "DocumentId": 6002,
      "DocumentUrl": "https://demowebsite.com/etk"
    }
  },
  "BranchAccess": [
    10580946,
    10580947
  ]
}

Örnek Response

{
    "status": "talebiniz alındı",
    "requestId": "bb844f8e-0286-480c-a20a-7684d2921234"
}

İzin İşlemi Onaylama - DOUBLE_OPT_IN

Endpoint URL

POST
https://api.dijiizin.com/api/V3/double-opt-in/consent/confirmation

Açıklama

Bu method ile SMS_OTP yöntemi ile izin alma işlemi başlatılabilir. Başarılı gerçekleşen istek sonrasında, 10 dakika içerisinde İzin İşlemi Onaylama işlemi gerçekleştirilmelidir. Aksi taktirde bu endpointe yeni istek göndererek yeni izin alma işlemi başlatılmalıdır. İzin işlemi başlatıldıktan sonra 1 ile 180 saniye arasında Girilen telefon numarasına ONAY SMS’i içerisinde 2 adet kod ve hukuki metinler gönderilecektir.

Parametreler

  • Name
    requestId
    Required State
    zorunlu
    Format
    string
    Description

    Başarı ile gerçekleşen İzin İşlemi Başlatma metodu cevabından dönen isteğinize ait tanımlayıcı uuid değeridir.

  • Name
    kvkkCode
    Required State
    zorunlu
    Format
    string
    Description

    Kişinin telefonuna SMS ile gönderilen 1. Kod olan KVKK ONAY kodunda yazan değerdir. KVKK Onayı alınması için kullanılır. KVKK kodu olmadan kişi kaydı yapılamaz.

  • Name
    etkCode
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin telefonuna SMS ile gönderilen 2. Kod olan ETK ONAY kodunda yazan değerdir. ETK onay kodu ile pazarlama izinleri ve ETK metin izini kayıt edilir.

Authorization

   Authentication: Bearer <jeton>

Örnek Request

POST
https://api.dijiizin.com/api/V3/double-opt-in/consent/confirmation
{
    "requestId":"48f833a6-67ec-4647-96fc-3a7ce3c6d815",
    "kvkkCode":"180546",
    "etkCode":"184287"
}

Örnek Response

{
    "status": "Kişi kayıt edildi",
    "uuid": "bb844f8e-0286-480c-a20a-7684d2921234"
}

İzin Alma - SINGLE_OPT_IN

Endpoint URL

POST
https://api.dijiizin.com/api/V3/single-opt-in/consent/add

Açıklama

Bu method ile dijital veya fiziksel ortamda alınan pazarlama izinleri, kvkk aydınlatma, KVKK'ya ilişikin açık rıza ve ETK onayı alınabilir. Bu method üzerinde "EvidenceFile" parametresi kesinlikle ve doğru biçimde gönderilmelidir.

  • Name
    Environment
    Required State
    zorunlu
    Format
    string
    Description

    İznin hangi elektronik ortamda alındığını belirtir. Zorunlu değerler: HS_EORTAM, HS_WEB, HS_MOBIL, HS_MESAJ, HS_EPOSTA, HS_CAGRI_MERKEZI, HS_SOSYAL_MEDYA Değerlerinden biri seçilmelidir.

  • Name
    EvidenceFile
    Required State
    zorunlu
    Format
    string
    Description

    İstekle beraber gönderilecek olan delil dosyası veya delil dosyası için oluşturulmuş metin base64 encodelanarak bu alanda gönderilmelidir. Ses, metin ya da benzeri kanıt olabilecek dosyalar gönderilecektir. Kanıt olarak sadece metin gönderilirse, tarafımızda bu metin txt dosya uzantısı ile kaydedilecektir.

    Örnek EvidenceFile İçeriği
  • Name
    EvidenceFileExtension
    Required State
    zorunlu
    Format
    string
    Description

    İstekle gönderilecek kanıt dosyasının uzantısıdır. Boş gönderilirse kanıt dosyasının uzantısı .txt olacaktır.

  • Name
    ConsentTime
    Required State
    zorunlu
    Format
    date d-m-Y H:i:s
    Description

    İznin alındığı tarihi ifade eder. `DD-MM-YYYY HH:mm:ss``formatıdna olmalıdır. Örn: 27-12-2022 02:25:12

  • Name
    Description
    Required State
    zorunlu
    Format
    string
    Description

    İzin alma sırasında gönderilen açıklama alanıdır.

  • Name
    Url
    Required State
    opsiyonel
    Format
    string
    Description

    İzin alma işleminin başladığı bağlantı adresidir. Eğer izin alma işlemi bir web sayfası üzerinde başlatılıyorsa gönderilmesi gereklidir

  • Name
    PersonalInfo
    Description

    PersonalInfo'nun istek içerisinde yer alması zorunludur. Ad Soyad alanı mutlaka doldurulmalıdır. Alınacak izinlere göre Phone ve Email alanlarından birini doldurmak yeterli olabilir.

  • Name
    PersonalInfo.Phone
    Required State
    opsiyonel zorunlu
    Format
    string
    Description

    ContactConsents bölümünde Sms veya Call izinleri “ONAY” durumunda gönderildiğinde doldurulması zorunludur. Başında 0 oladan 10 haneli olarak gönderilmelidir.

  • Name
    PersonalInfo.Email
    Required State
    opsiyonel zorunlu
    Format
    string
    Description

    ContactConsents bölümünde Email “ONAY” durumunda gönderildiğinde doldurulması zorunludur. E-posta formatına uygun olarak gönderilmelidir.

  • Name
    DocumentConsents.KVKK
    Required State
    zorunlu
    Description

    Kişinin kaydedilecek KVKK izinlerini ifade eder. İçerisinde dijiizin’den alacağınız KVKK metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır.

  • Name
    DocumentConsents.RIZA
    Required State
    zorunlu
    Description

    Kişinin kaydedilecek KVKK’ya ait açık rıza izinlerini ifade eder. İçerisinde dijiizin’den alacağınız Açık Rıza metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır.

  • Name
    ContactConsents
    Required State
    zorunlu
    Description

    Eğer kişiye ilişkin pazarlama izinlerini almak istiyorsanız ContactConsent parametresi gönderilmelidir.

  • Name
    ContactConsents.Type
    Required State
    zorunlu
    Format
    string
    Description

    İznin ticari veya bireysel olup olmadığını ifade eder. Ticari izinler için TACIR bireysel izinler için BIREYSEL olarak değer gönderilmelidir. ContactConsents parametresi gönderildiği taktirde bu alanın gönderilmesi zorunludur.

  • Name
    ContactConsents.Sms
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin MESAJ pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. SMS pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.Call
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin ARAMA pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. ARAMA pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.Email
    Required State
    opsiyonel
    Format
    string
    Description

    Kişinin EPOSTA pazarlama iznini ifade eder. Değeri Boş gönderilemez. Değeri ONAY olmalıdır. EPOSTA pazarlama izni alınmayacaksa parametre istek içerisinde yer almamalıdır.

  • Name
    ContactConsents.ETK
    Required State
    opsiyonel zorunlu
    Description

    Kişinin kaydedilecek ETK’ya ait açık rıza izinlerini ifade eder. İçerisinde dijiizin’den alacağınız ETK metninize ilişikin DocumentId değeri ve eğer bu izni web de bulunan kişinin doldurduğu bir form üzerinden alıyorsanız aynı DocumentId değerine sahip metnin bir kopyasının bulunduğu DocumentUrl bulunmalıdır. ContactConsents parametresi gönderildiği taktirde bu alanın gönderilmesi zorunludur.

  • Name
    BranchAccess
    Required State
    opsiyonel
    Description

    Kişiye ve izinlerine erişim izni vereceğiniz şubeleri ifade eder. İstek gövdesinde yer alması zorunlu değildir. İletildiğinde dizi olarak brand_id değerleri gönderilmelidir. BranchId değerleri gönderildiğinde, Firma ana yetklisi dışında sadece gönderilen BranchId değerine karşılık gelen şubenin kullanıcıları bu kişiye erişim sağlayabilecektir.

Authorization

   Authentication: Bearer <jeton>

Örnek Request

POST
https://api.dijiizin.com/api/V3/single-opt-in/consent/add
{
  "Environment": "HS_EORTAM",
  "EvidenceFile": "a2FuxLF0IGnDp2VyacSfaQ==",
  "EvidenceFileExtension": "txt",
  "PersonalInfo": {
    "Name": "Ahmet",
    "Surname": "Öztürk",
    "Phone": "5361000000",
    "Email": "destek@dijiizin.com"
  },
  "ConsentTime": "27-12-2022 02:25:12",
  "Description": "Dijiizin.com üzerinde yeni üyelik işlemi ile izin alındı",
  "Url": "dijiizin.com/yeni-uyelik",
  "DocumentConsents": {
    "KVKK": {
      "DocumentId": 633,
      "DocumentUrl": "https://demowebsite.com/kvkk"
    },
    "RIZA": {
      "DocumentId": 650,
      "DocumentUrl": "http://demowebsite.com/acikriza"
    }
  },
  "ContactConsents": {
    "Type": "BIREYSEL",
    "Sms": "ONAY",
    "Call": "ONAY",
    "Email": "ONAY",
    "ETK": {
      "DocumentId": 632,
      "DocumentUrl": "https://demowebsite.com/etk"
    }
  }
}

Örnek Response

{
    "status": "Kişi Kayıt Edildi",
    "uuid": "bb844f8e-0286-480c-a20a-7684d2921234"
}

Bu doküman size yardımcı oldu mu?