A3.Drive продукттарга файлдар менен иштөө үчүн тар интерфейс берет. Продукт келишимди гана билет жана сактагычтын ички түзүлүшүнө көз каранды эмес. A3 продукттары кардардын башка системалары менен бирдей келишим аркылуу, ички айланма жолдорсуз иштейт.
Продукт файлдарды өзүндө сактоону токтотушу үчүн жетиштүү төрт ыкма. Калган мүмкүнчүлүктөр ошол эле маалымат моделинин үстүндөгү кеңейтүүлөр болуп саналат.
put(bytes, meta) -> { file_id, version_id }Объектти жана анын биринчи версиясын түзөт. Түзүүдөн мурун content_hash, башкача айтканда мазмундун хэшин салыштырат: байт боюнча бирдей көчүрмөнү экинчи объект катары сактоонун ордуна байланыштыруу сунушталат.
get(file_id, { format, size, version }) -> FileDTOУкуктарды текшерет, аракет классы боюнча шилтеменин жарактуулук мөөнөтүн тандайт жана кыска мөөнөттүү кол коюлган шилтеме чыгарат. Сүрөттөр үчүн керектүү өлчөмдү берет: эскиз, орточо же толук.
bind(file_id, { product_id, entity_type, entity_id, deep_link, version_pin? }) -> { binding_id }Кармоочуну, башкача айтканда файлдын продукт объектисине байланышын түзөт: бүтүмгө, кайрылууга, эсепке. Байланыш бар объектке шилтейт, аны көчүрбөйт. Белгилүү версияны бекитүүгө болот.
unlink(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_KEYA3SessionDomainCompanyIdProductIdLanguage-CodeTTL (time to live) деп кол коюлган шилтеме файлды ачкан убакытты айтабыз. Ал шилтеме берилген аракеттин узактыгына барабар. Бул жөндөөлөрдөгү бир сан эмес, аракет классы жана файлдын сезгичтиги боюнча саясат. Шилтеме жарактуу болуп турганда укукту артка кайтаруу ага али таасир этпейт, ошондуктан мөөнөт кыска кармалат.
Ошол эле маалымат моделинин үстүндө өсөт. Продукттар өзөк даяр болгондо келишимге кошулат жана сактагычтын калган мүмкүнчүлүктөрүн күтпөйт.
list_versionsfreeze_versionВерсиялар тарыхы жана версияны бекитүүset_retentionОбъектти өчүрүүгө болбогон сактоо мөөнөтүsearchАталышы жана мазмуну боюнча издөөcreate_public_linkМөөнөтү, сырсөзү жана артка кайтаруусу бар ачык шилтемеlist_holdersОбъект колдонулган жерлердин тизмесиregister_productset_scopeИнтеграцияны каттоо жана анын кирүү укуктарыFiles/MintEditTokenWOPIОнлайн редактор үчүн токен. WOPI: кеңсе редактору файлды түз эле сактагычтан ачкан протоколSync/ChangesАкыркы шайкештирүүдөн берки өзгөрүүлөр, курсор боюнча