Documentolog ilovasiIlovada ochish
logo

Documentolog ochiq API'dan foydalanish bo'yicha ko'rsatma

Documentolog turli tizimlar bilan integratsiya qilish uchun ochiq API taqdim etadi, bu hujjatlarni imzolash va yuborish kabi jarayonlarni avtomatlashtirish imkonini beradi.

API'dan foydalanish uchun Documentolog tizimida ro'yxatdan o'tish va API-kalit olish kerak

1-bosqich: Tizimda ro'yxatdan o'tish
  1. https://documentolog.com/ saytida "Bepul boshlash" tugmasini bosing va Documentolog tizimida ro'yxatdan o'ting.

  2. Documentolog API'ga kirish uchun Start+ yoki Business tarifini sotib olish kerak. Batafsil: https://documentolog.com/tariffs

  3. Tarifni to'laganingizdan keyin "Mening tashkilotim" bo'limiga o'ting

  4. "Sozlamalar" yorlig'iga o'ting

  5. "Integratsiyalar" bo'limini oching

2-bosqich: API-kalit olish
  1. API-kalitingizni nusxalang yoki yangisini yarating

img
  1. Kalitni xavfsiz joyda saqlang, chunki u so'rovlaringizni autentifikatsiya qilish uchun ishlatiladi.

3-bosqich: Iframe'ga o'rnatish uchun Access Token olish

Access Token API orqali hujjatlar bilan ishlash va ularni imzolash uchun zarur

1-qism: Access Token olish

1.1 Access Token so'rovi:

Access Token olish uchun quyidagi c URL so'rovini bajaring:

curl --location 'https://apibusiness.documentolog.com/json/external/oauth/token' \
      --header 'api-key: {{api-key}}' \
      --header 'Content-Type: application/json' \
      --data '{
          "aAttachments": [
              "https://business.documentolog.com/icons/android-icon-192x192.png"
          ],
          "sSetWebhookUrl": "https://apibusiness.documentolog.com/external/test/webhook",
          "iSendToRecipient": 1,
          "mRecipient": [
              "000000000000"
          ],
          "iRecipientSignatureRequired": 1,
          "mAvailableSignatureMethodsForRecipient": [
              "eds",
              "egov-qr"
          ],
          "mAvailableSignatureMethods": [
              "eds",
              "egov-qr"
          ],
          "sSender": "000000000000"
      }'

1.2 So'rov parametrlari:

  • aAttachments: Fayllarga havolalar massivi (qo'llab-quvvatlanadigan formatlar: docx, doc, xlsx, xls, pptx, ppt, pdf, rar, zip, rtf, tiff, jpeg, jpg, png, gdoc).

  • sSetWebhookUrl: Imzolashdan keyin natijalarni olish uchun URL.

  • iSendToRecipient: Hujjatni qabul qiluvchiga yuborish kerakmi (1 = ha, 0 = yo'q).

  • mRecipient: Qabul qiluvchilar ro'yxati (IIN, BIN yoki elektron pochta ishlatilishi mumkin).

  • iRecipientSignatureRequired: Qabul qiluvchi imzosi talab qilinadimi (1 = ha, 0 = yo'q).

  • mAvailableSignatureMethodsForRecipient: Qabul qiluvchi uchun imzolash usullari (masalan, eds, egov-qr).

  • mAvailableSignatureMethods: Yuboruvchi uchun imzolash usullari (masalan, eds, egov-qr).

  • sSender: Yuboruvchi identifikatsiya raqami.

1.3 So'rov natijasi

Muvaffaqiyatli javob quyidagi formatga ega bo'ladi:

{
          "status": 1,
          "data": {
              "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
              "scope": "document-create|document-sign|document-show",
              "token_type": "Bearer"
          }
      }
  • Access_token: Resurslarga kirish uchun ishlatilishi kerak bo'lgan token.

  • scope: Hujjatlar bilan mavjud harakatlar.

  • token_type: Token turi, odatda "Bearer".

2-qism: Iframe'ga token o'rnatish

Access token olingandan keyin, uni keyingi foydalanish uchun iframe'ga o'rnatish mumkin.

2.1 O'rnatish uchun URL

Olingan Access Token'ni qo'yib quyidagi URL'dan foydalaning:

https://apibusiness.documentolog.com/external/sign/embedded?sParams={{data.access_token}}

O'rnatish misoli:

<iframe src="https://apibusiness.documentolog.com/external/sign/embedded?sParams=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." width="400px" height="600px"></iframe>
3-qism: postMessage hodisasi

3.1 Imzolash natijasi

Imzolash jarayoni tugaganda, iframe window.parent.postMessage funksiyasi yordamida ota oynaga xabar yuboradi. Mana xabar misoli:

{
      	isDocumentolog: true,
      	type: 'sign',
      	success: true | false,
      	signType: 'eds' | 'egov_gr'
}
  • isDocumentolog: Documentolog tizimidan foydalanishni ko'rsatuvchi bayroq (har doim true).

  • type: Hodisa turi.

  • success: Imzolash natijasi.

  • signType: Imzolashda ishlatilgan imzo turi (masalan, 'eds')

3.2 Iframe'ni yopish

Foydalanuvchi iframe'ni yopishga harakat qilganda, iframe window.parent.postMessage funksiyasi yordamida ota oynaga xabar yuboradi. Mana xabar misoli:

{
      	isDocumentolog: true,
      	type: 'user-close',
      	success: false,
}
  • isDocumentolog: Documentolog tizimidan foydalanishni ko'rsatuvchi bayroq (har doim true).

  • type: Hodisa turi.

  • success: Imzolash natijasi.

4-qism: Webhook

sWebhook maydonida ko'rsatilgan joyga hujjat imzolashdan keyin xabar yuboriladi:

{
          "content": {
              "document": "https://apibusiness.documentolog.com/external/document/view-document/dcs_universal_type/1234",
              "download_all_files": "https://apibusiness.documentolog.com/external/media/download-many?files=4444",
              "download_files": [
                  {
                      "name": "android-icon-192x192.png",
                      "link": "https://apibusiness.documentolog.com/external/media/download/4444"
                  }
              ],
              "download_files_with_eds": [
                  {
                      "name": "android-icon-192x192.png",
                      "link": "https://apibusiness.documentolog.com/external/media/download-eds/dcs_universal_type/1234/4444"
                  }
              ],
              "download_files_with_eds_ez": [
                  {
                      "name": "android-icon-192x192.png",
                      "link": "https://apibusiness.documentolog.com/external/media/download-eds-ez/dcs_universal_type/1234/4444"
                  }
              ]
          }
      }
Salom! Agar savollar bo'lsa, yordam beraman!
Chat'ga ulanmoqda...
Ishlab chiqilganDocumentolog