Ombor shartnomasi

A3.Drive mahsulotlarga fayllar bilan ishlash uchun tor interfeys beradi. Mahsulot faqat shartnomani biladi va omborning ichki tuzilishiga bogʻliq emas. A3 mahsulotlari mijozning boshqa tizimlari bilan bir xil shartnoma orqali, ichki aylanma yoʻllarsiz ishlaydi.

Shartnoma yadrosi

Mahsulot fayllarni oʻzida saqlashni toʻxtatishi uchun yetarli toʻrtta usul. Qolgan imkoniyatlar xuddi shu maʼlumotlar modeli ustidagi kengaytmalardir.

01put(bytes, meta) -> { file_id, version_id }

Faylni kiritish

Obyekt va uning birinchi versiyasini yaratadi. Yaratishdan oldin content_hash, yaʼni tarkib xeshini solishtiradi: baytma-bayt bir xil nusxani ikkinchi obyekt sifatida saqlash oʻrniga bogʻlash taklif qilinadi.

02get(file_id, { format, size, version }) -> FileDTO

Faylni olish

Huquqlarni tekshiradi, amal sinfi boʻyicha havolaning amal qilish muddatini tanlaydi va qisqa muddatli imzolangan havola chiqaradi. Rasmlar uchun kerakli oʻlchamni beradi: eskiz, oʻrta yoki toʻliq.

03bind(file_id, { product_id, entity_type, entity_id, deep_link, version_pin? }) -> { binding_id }

Obyektga bogʻlash

Ushlab turuvchini, yaʼni faylning mahsulot obyektiga bogʻlanishini yaratadi: bitimga, murojaatga, hisobga. Bogʻlanish mavjud obyektga ishora qiladi, uni nusxalamaydi. Muayyan versiyani qayd etish mumkin.

04unlink(binding_id, capability_token) -> { ok }

Bogʻlanishni olib tashlash

Identifikatori boʻyicha aynan bitta bogʻlanishni olib tashlaydi. Chaqiruv capability-token, yaʼni bitta amal uchun bir martalik imzolangan token bilan tasdiqlanadi. Alohida oʻchirish buyrugʻi yoʻq: ushlab turuvchisi qolmagan obyekt tozalashga oʻzi ketadi.

Fayl maʼlumotlari bilan yagona javob

DTO (data transfer object) fayl maydonlari bilan javob shaklidir. Uni shartnoma bir marta belgilaydi. Mahsulotlar uni faqat uzatadi va oʻz maydonlarini qoʻshmaydi, aks holda umumiy koʻrish vositasi va umumiy fayl tanlash oynasi ishlamay qoladi. status maydoni majburiy: usiz interfeys tahrirlashni yoki faqat koʻrishni taklif qilishni bilmaydi.

Javobdagi havolalar qisqa muddatli. Ilova ularni uzoq saqlamaydi: muddati tugaganda faylni qayta soʻraydi.

{
  "file_id": "b1f0c2e4-...",
  "version_id": "9a77d1c0-...",
  "name": "Regulation.docx",
  "mime": "application/vnd.openxmlformats-...",
  "size_bytes": 84213,
  "status": "signed",
  "permissions": {
    "can_edit": false,
    "can_download": true,
    "can_delete": false
  },
  "download_url": "https://.../signed?exp=...",
  "thumbnail_url": "https://.../thumb?exp=..."
}

Transport sarlavhalari

Sarlavhalar orqali ombor usulni kim va kimning nomidan chaqirayotganini tushunadi. Javob har doim bitta qobiqda keladi, foydali maʼlumotlar value maydonida turadi. Roʻyxatlar umumiy soni bilan qaytariladi, filtrlar va sahifalab chiqarish soʻrov parametrlarida obyekt sifatida uzatiladi.

Javob qobigʻi
{ code, errorCode, success, value }
Roʻyxat
{ items: T[], totalCount }
API_KEY
Integratsiyalar reyestridagi chaqiruvchi mahsulot kaliti
A3Session
Foydalanuvchi ssenariylari uchun A3.ID dagi foydalanuvchi sessiyasi
Domain
Foydalanuvchi ssenariylaridagi biznes domeni
CompanyId
Domen kompaniyasi. U boʻyicha tashkilotlar maʼlumotlari ajratiladi, kvotalar va tozalash hisoblanadi
ProductId
Chaqiruv uning nomidan amalga oshiriladigan mahsulot
Language-Code
Xato matnlari tili: RU, EN, KK, KY, MN, UZ. Standart boʻyicha RU

Havolalarning amal qilish muddati

TTL (time to live) imzolangan havola faylni ochadigan vaqtdir. U havola berilgan amalning davomiyligiga teng. Bu sozlamalardagi bitta raqam emas, amal sinfi va faylning sezgirligi boʻyicha siyosat. Havola amal qilayotganda huquqni bekor qilish unga hali taʼsir qilmaydi, shuning uchun muddat qisqa saqlanadi.

SinfKattalik tartibiIzoh
Sahifada koʻrsatishDaqiqalarRasm yoki eskizni bir marta koʻrsatish. Havola jurnallarga tushsa, u allaqachon amal qilmaydi.
Bosish orqali yuklab olishOʻnlab daqiqaFaylni yangi oynada ochib, chalgʻib qolgan holatga ham yetadi.
Ochiq havolaKunlar va haftalarEgasining ongli siyosati: muddat, parol va bekor qilish.
Imzolangan faylEng qisqaHuquqni bekor qilish hali kuchga kirmagan oyna ataylab kichik qilinadi.

Shartnoma kengaytmalari

Xuddi shu maʼlumotlar modeli ustida oʻsadi. Mahsulotlar yadro tayyor boʻlishi bilan shartnomaga ulanadi va omborning qolgan imkoniyatlarini kutmaydi.

  • list_versionsfreeze_versionVersiyalar tarixi va versiyani qayd etish
  • set_retentionObyektni oʻchirib boʻlmaydigan saqlash muddati
  • searchNom va tarkib boʻyicha qidiruv
  • create_public_linkMuddat, parol va bekor qilish imkoniyati bor ochiq havola
  • list_holdersObyekt ishlatiladigan joylar roʻyxati
  • register_productset_scopeIntegratsiyani roʻyxatdan oʻtkazish va uning kirish huquqlari
  • Files/MintEditTokenWOPIOnlayn muharrir uchun token. WOPI: ofis muharriri faylni toʻgʻridan-toʻgʻri ombordan ochadigan protokol
  • Sync/ChangesOxirgi sinxronlashdan keyingi oʻzgarishlar, kursor boʻyicha