Құжаттарға қол қою Documentolog API арқылы

Жылдам іске қосу және заңдық күш

Құжат

Қалыптастырылуда

Қол қою

Аяқталды

Интеграция туралы

Сіздің өніміңізге заңдық маңызы бар құжаттарға қол қою

Бұл шешім кімге қолайлы:

  • Банктер және финтех компаниялар: несиелік шарттар, келісімдер, қосымша келісімдер және т.б.

  • B2B SaaS жүйелер: шарттар, акттер және NDA

  • Маркетплейстер: салыстыру акттері, сатушылармен/сатып алушылармен шарттар,

  • Компаниялардың басқа түрлері

Documentolog API мүмкіндіктері:

  • Құжаттарды жасау және оларды API сұрауы арқылы қол қоюға жіберу

  • Documentolog-тың заңдық маңызы бар инфрақұрылымын пайдалану

  • Қол қоюдың бірнеше әдісін қолдау: ЭЦҚ, Egov QR, SMS, Adobe Sign

  • Қол қою процесін iframe арқылы сіздің интерфейсіңізге енгізу

  • Webhook арқылы қол қою нәтижесін алу

Процесс сипаттамасы

Құжатты жіберу және қол қою

  1. Бастамашы шарт файлын жүйеге жүктейді — PDF, Word, Excel және басқа форматтарға қолдау көрсетіледі.
  2. Бастамашы алушыны көрсетеді — телефон нөмірі, ЖСН, БСН немесе email бойынша.
  3. Бастамашы жіберу түрін таңдайды: тек көру немесе қол қою.
  4. Бастамашы «Жіберу» түймесін басады және қажет болса құжатқа өзі қол қояды — одан кейін құжат алушыға жіберіледі.
  5. Алушы сілтеме немесе хабарлама алып, құжатты өз құрылғысында ашады. Егер алушы Documentolog Business-та тіркелген болса, құжат оның жүйесінде автоматты түрде пайда болады.
  6. Алушы өзіне ыңғайлы қол қою әдісін таңдап, құжатқа қол қояды.
  7. Бастамашы қол қойылғаны туралы хабарламаны және дайын файлды алады

Алушы құжатқа қол қойған жоқ

Алушы құжатты өз құрылғысында ашады:

  1. Егер алушы қол қоймауды шешсе — ол «Қабылдамау» түймесін басады. Бастамашы бірден хабарлама алады және себептерін нақтылау үшін алушымен байланыса алады.
  2. Егер алушы шешім қабылдамай құжатты жапса — сілтеме 30 күн бойы белсенді болып қалады. Бастамашы «Қол қойылмады» мәртебесін көреді және қайта еске салу жібере алады.

Әзірлеушілерге арналған құжаттама

Бұл құжаттама access token алу және оны iframe-ге енгізу үшін пайдалану процесін сипаттайды.
Бұл құжаттармен жұмыс істеу және оларға API арқылы қол қою үшін қажет

Интеграцияны бастау үшін жүйеде тіркелу қажет:

  1. Сайтта https://documentolog.com/ "Тегін бастау" түймесін басып, Documentolog Business жүйесінде тіркеліңіз.

  2. Documentolog API-ге қол жеткізу үшін Business тарифін сатып алу қажет. Толығырақ: https://documentolog.com/tariffs

  3. Тарифті төлегеннен кейін "Интеграциялар" бөліміне өтіңіз

  4. "API Documentolog" қойындысына өтіңіз

1-бөлім: Access Token алу

1.1 Access Token сұрауы

Access token алу үшін келесі cURL сұрауын орындаңыз:

36 жол

01

02

03

04

05

06

07

08

09

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

curl --location 'https://apiv1dlkz.doculite.kz/json/external/oauth/token' \

--header 'api-key: {{api-key}}' \

--header 'Content-Type: application/json' \

--data '{

"aAttachments": [

"https://dlkz.doculite.kz/rct/sample.pdf"

],

"sSetWebhookUrl": "https://your-server.com/webhook",

"iSendToRecipient": 1,

"mRecipient": [

"000000000000"

],

"mPhonesForSms": [

{

"enableBMG": false,

"phone": "+X (XXX) XXX-XX-XX",

"fio": "Simple name",

"iin": "",

"type": "sms"

}

],

"iRecipientSignatureRequired": 1,

"mAvailableSignatureMethodsForRecipient": [

"eds",

"egov-qr",

"adobe-sign",

"sms"

],

"mAvailableSignatureMethods": [

"eds",

"egov-qr",

"adobe-sign",

"sms"

],

"sSender": "000000000000"

}'

1.2 Сұрау параметрлері

Сұрау денесінің параметрлері:

  • aAttachments — қол қою керек файлдарға сілтемелер массиві

  • sSetWebhookUrl — қол қойылғаннан кейін webhook хабарламасын алу үшін URL

  • iSendToRecipient — құжатты алушыға жіберу жалауы (1 — жіберу)

  • mRecipient — құжат алушыларының ЖСН массиві

  • mPhonesForSms — алушылар үшін SMS қол қою параметрлері

    • enableBMG — SMS жіберу үшін BMG қызметін пайдалану-пайдаланбау

    • phone — алушының телефон нөмірі +X (XXX) XXX-XX-XX форматында

    • fio — алушының толық аты-жөні

    • iin — алушының ЖСН-і

    • type — жіберу түрі (sms)

  • iRecipientSignatureRequired — алушының қолтаңбасы қажет пе (1 — иә)

  • mAvailableSignatureMethodsForRecipient — алушы үшін қолжетімді қол қою әдістері

  • mAvailableSignatureMethods — жіберуші үшін қолжетімді қол қою әдістері

  • sSender — құжат жіберушінің ЖСН-і

1.3 Сұрау нәтижесі

Сұрау сәтті болған жағдайда сіз мәртебе және токен деректері бар JSON жауап аласыз:

8 жол

01

02

03

04

05

06

07

08

{

"status": 1,

"data": {

"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",

"scope": "document-create|document-sign|document-show",

"token_type": "Bearer"

}

}

  • access_token — iframe авторизациясы үшін JWT-токен

  • scope — рұқсат етілген операциялар (жасау, қол қою, көру)

  • token_type — токен түрі (Bearer)

2-бөлім: Токенді iframe-ге енгізу

access_token алғаннан кейін iframe үшін URL қалыптастырып, оны өз бетіңізге енгізіңіз.

Жауаптан access_token мәнін қойып URL қалыптастырыңыз:

1 жол

01

https://apiv1dlkz.doculite.kz/external/sign/embedded?sParams={{data.access_token}}

Iframe-ді HTML-ге енгізу мысалы:

1 жол

01

<iframe src="https://apiv1dlkz.doculite.kz/external/sign/embedded?sParams=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." width="400px" height="600px"></iframe>

Құжатқа қол қою үшін iframe-нің сыртқы түрі

Құжатқа қол қою үшін iframe-нің сыртқы түрі

3-бөлім: postMessage оқиғасы

3.1 Қол қою нәтижесі

Құжатқа қол қойылғаннан кейін iframe нәтижесімен postMessage оқиғасын жібереді. Деректерді алу үшін message оқиғасына жазылыңыз:

6 жол

01

02

03

04

05

06

{

isDocumentolog: true,

type: 'sign',

success: true | false,

signType: 'eds' | 'egov_gr'

}

  • isDocumentolog — оқиғаның Documentolog-қа тиесілілік жалауы

  • type — оқиға түрі

  • success — операция нәтижесі (true — сәттілік, false — қате)

  • signType — қол қою әдісі (eds немесе egov_gr)

3.2 Iframe-ді пайдаланушы жапты

Егер пайдаланушы қол қою формасын қол қоймай жапса, жеке хабарлама жіберіледі:

5 жол

01

02

03

04

05

{

isDocumentolog: true,

type: 'user-close',

success: false,

}

  • isDocumentolog — оқиғаның Documentolog-қа тиесілілік жалауы

  • type — оқиға түрі

  • success — операция нәтижесі (true — сәттілік, false — қате)

3.3 Құжат бұрын қол қойылған

Егер iframe-де ашылатын құжатқа бұрын қол қойылған болса, келесі хабарлама жіберіледі:

5 жол

01

02

03

04

05

{

isDocumentolog: true,

type: 'already-signed',

success: true,

}

  • type — оқиға түрі

  • success — операция нәтижесі (true — сәттілік, false — қате)

4-бөлім: Webhook

4.1 Webhook оқиғалары

Құжатпен жұмыс барысында sSetWebhookUrl параметрінде көрсетілген URL-ге негізгі оқиғалар туралы ақпаратпен POST-сұраулар жіберіледі:

4 жол

01

02

03

04

{

"event": "document_sent",

"doc_id": "KZ000000000000000001234567"

}

8 жол

01

02

03

04

05

06

07

08

{

"event": "signer_signed"|"signer_declined",

"doc_id": "KZ000000000000000001234567",

"signer": {

"name": "Сейтқали Нұрлан",

"recipient": "000000000000"

}

}

  • event — оқиға түрі (document_sent, signer_signed, signer_declined)

  • doc_id — құжат идентификаторы

  • signer — қол қоюшы деректері

    • name — қол қоюшының толық аты-жөні

    • recipient — қол қоюшының ЖСН-і

4.2 Қол қоюды аяқтау

Құжатқа барлық тараптар қол қойғаннан кейін webhook URL-ге файлдарды көру және жүктеу сілтемелерімен қорытынды оқиға жіберіледі:

24 жол

01

02

03

04

05

06

07

08

09

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

{

"event": "document_completed",

"doc_id": "KZ000000000000000001234567",

"document": "https://apiv1dlkz.doculite.kz/external/document/view-document/dcs_universal_type/1234",

"download_all_files": "https://apiv1dlkz.doculite.kz/external/media/download-many?files=4444",

"download_files": [

{

"name": "sample.pdf",

"link": "https://apiv1dlkz.doculite.kz/external/media/download/4444"

}

],

"download_files_with_eds": [

{

"name": "sample.pdf",

"link": "https://apiv1dlkz.doculite.kz/external/media/download-eds/dcs_universal_type/1234/4444"

}

],

"download_files_with_eds_ez": [

{

"name": "sample.pdf",

"link": "https://apiv1dlkz.doculite.kz/external/media/download-eds-ez/dcs_universal_type/1234/4444"

}

]

}

  • event — оқиға түрі (document_completed)

  • doc_id — құжат идентификаторы

  • document — құжатты көру сілтемесі

  • download_all_files — барлық файлдарды бір архивпен жүктеу сілтемесі

  • download_files — жүктеуге арналған файлдар тізімі

  • download_files_with_eds — тіркелген ЭЦҚ қолтаңбалары бар файлдар тізімі

  • download_files_with_eds_ez — Ez форматындағы ЭЦҚ қолтаңбалары бар файлдар тізімі