Агуулахын гэрээ

A3.Drive бүтээгдэхүүнүүдэд файлтай ажиллах нарийн интерфейс өгдөг. Бүтээгдэхүүн зөвхөн гэрээг мэдэх бөгөөд агуулахын дотоод бүтцээс хамаарахгүй. A3 бүтээгдэхүүнүүд үйлчлүүлэгчийн бусад системтэй ижил гэрээгээр, дотоод тойруу замгүйгээр ажилладаг.

Гэрээний цөм

Бүтээгдэхүүн файлыг өөртөө хадгалахаа болиход хангалттай дөрвөн арга. Бусад боломж бол яг тэр өгөгдлийн загвар дээрх өргөтгөл юм.

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

Файл оруулах

Объект ба түүний эхний хувилбарыг үүсгэнэ. Үүсгэхийн өмнө content_hash буюу агуулгын хэшийг тулгана: байт бүрээрээ ижил хуулбарыг хоёр дахь объект болгон хадгалахын оронд холбохыг санал болгоно.

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

Файл авах

Эрхийг шалгаж, үйлдлийн ангиар холбоосын хүчинтэй хугацааг сонгоод богино хугацаатай, гарын үсэгтэй холбоос гаргана. Зурагт шаардлагатай хэмжээг өгнө: жижиг, дунд эсвэл бүтэн.

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

Объектод холбох

Эзэмшигч буюу файлыг бүтээгдэхүүний объекттой холбосон холбоосыг үүсгэнэ: хэлцэл, хүсэлт, нэхэмжлэх. Холбоос байгаа объектыг зааж, түүнийг хуулахгүй. Тодорхой хувилбарыг тогтоож болно.

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

Холбоос салгах

Танигчаар нь яг нэг холбоосыг салгана. Дуудлагыг capability-токен буюу нэг үйлдэлд зориулсан нэг удаагийн гарын үсэгтэй токеноор баталгаажуулна. Тусдаа устгах команд байхгүй: эзэмшигчгүй болсон объект өөрөө цэвэрлэгээнд орно.

Файлын өгөгдөлтэй нэгдсэн хариу

DTO (data transfer object) бол файлын талбаруудтай хариултын хэлбэр юм. Үүнийг гэрээ нэг удаа тодорхойлно. Бүтээгдэхүүнүүд түүнийг зөвхөн дамжуулах бөгөөд өөрийн талбар нэмэхгүй, эс тэгвэл нийтлэг үзүүлэгч, нийтлэг файл сонгох цонх ажиллахаа болино. status талбар заавал байна: түүнгүйгээр интерфейс засварлахыг эсвэл зөвхөн үзэхийг санал болгохоо мэдэхгүй.

Хариултын холбоос богино хугацаатай. Аппликейшн тэдгээрийг удаан хадгалахгүй: хугацаа дуусахад файлыг дахин хүснэ.

{
  "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=..."
}

Тээврийн толгойнууд

Толгойнуудаар агуулах аргыг хэн, хэний нэрийн өмнөөс дуудаж байгааг ойлгоно. Хариу үргэлж нэг бүрхүүлээр ирж, ашигтай өгөгдөл value талбарт байна. Жагсаалт нийт тоотойгоо буцаж, шүүлт, хуудаслалт хүсэлтийн параметрт объект хэлбэрээр дамжина.

Хариултын бүрхүүл
{ code, errorCode, success, value }
Жагсаалт
{ items: T[], totalCount }
API_KEY
Интеграцын бүртгэл дэх дуудагч бүтээгдэхүүний түлхүүр
A3Session
Хэрэглэгчийн хувилбаруудад зориулсан A3.ID хэрэглэгчийн сешн
Domain
Хэрэглэгчийн хувилбарууд дахь бизнесийн домэйн
CompanyId
Домэйны компани. Үүгээр байгууллагуудын өгөгдлийг салгаж, квот ба цэвэрлэгээг тооцно
ProductId
Дуудлага түүний нэрийн өмнөөс хийгдэх бүтээгдэхүүн
Language-Code
Алдааны текстийн хэл: RU, EN, KK, KY, MN, UZ. Анхдагчаар RU

Холбоосын хүчинтэй хугацаа

TTL (time to live) бол гарын үсэгтэй холбоос файлыг нээх хугацаа юм. Энэ нь холбоос олгосон үйлдлийн үргэлжлэх хугацаатай тэнцүү. Энэ бол тохиргооны нэг тоо биш, үйлдлийн анги ба файлын эмзэг байдлаар тогтоох бодлого. Холбоос хүчинтэй байх үед эрх цуцлах нь түүнд хараахан нөлөөлөхгүй тул хугацааг богино байлгадаг.

АнгиХэмжээний дараалалТайлбар
Хуудсанд харуулахМинутЗураг эсвэл урьдчилсан харагдацыг нэг удаа харуулах. Холбоос бүртгэлд орсон бол аль хэдийн хүчингүй.
Дараад татахХэдэн арван минут«Шинэ табд нээгээд анхаарал сарнилаа» гэсэн тохиолдолд хүрэлцэнэ.
Нийтийн холбоосӨдөр, долоо хоногЭзэмшигчийн ухамсартай бодлого: хугацаа, нууц үг, цуцлалт.
Гарын үсэгтэй файлХамгийн богиноЭрх цуцлалт хараахан хүчин төгөлдөр болоогүй цонхыг зориуд жижиг болгодог.

Гэрээний өргөтгөл

Яг тэр өгөгдлийн загвар дээр нэмэгдэнэ. Бүтээгдэхүүнүүд цөм бэлэн болмогц гэрээнд холбогдох бөгөөд агуулахын бусад боломжийг хүлээхгүй.

  • list_versionsfreeze_versionХувилбарын түүх ба хувилбар тогтоох
  • set_retentionОбъектыг устгах боломжгүй хадгалалтын хугацаа
  • searchНэр, агуулгаар хайх
  • create_public_linkХугацаа, нууц үг, цуцлалттай нийтийн холбоос
  • list_holdersОбъект ашиглагдаж буй газрын жагсаалт
  • register_productset_scopeИнтеграц бүртгэх ба түүний хандах эрх
  • Files/MintEditTokenWOPIОнлайн засварлагчийн токен. WOPI: оффисын засварлагч файлыг агуулахаас шууд нээх протокол
  • Sync/ChangesСүүлийн синхрончлолоос хойших өөрчлөлт, курсороор