API
DiMaker API-сы қолдана отырып, жеке деректермен файлдар жасауға, қажет болғанда оларды қабылдайтын адамдарға беру мүмкіндігі бар. API-ға запрос жасау мағынасында басқа сервернен немесе CORS арқылы браузерден қосулар болуы мүмкін.
Қайталап басу қалай
«Интеграция» бөлімінде «API токендері»нен Secure токен алу қажет және осы токенді пайдалануға рұқсат беру керек. Басқа керекті деректермен файлды жасау үшін документ, электронды пошта рассылкалары үшін пішін шаблоны және дайын файлдар үшін Дискте папка жасау қажет.
Файлдарды жасау
Файлдарды жасау үшін POST-DATA, POST-JSON немесе GET запростарын жіберу керек
https://dimaker.app/api/v1/create/
адрестірілген ақпараттармен. Запрос кодталуы UTF-8. Міндетті тармақтар * белгіленген.
-
secure*
Токен (тізбек, 36 символов)
-
doc_id*
Файлды ұқсау үшін пайдаланылатын (36 символдан артық болмауы керек) документтің ID-сы. ID документ ашық болғанда мекенжай жолдан алу керек. Документ қарыжайды, бірақ Дисктегі өзгерту істерінде бола алады.
-
mask*
JSON-тапсырмасы, аты (переменная) - мән (алмасу үшін мәтін) пішін. Бірнеше файлдарды құру үшін кейбір енгізулерді ұсынуға болады (шектеулерсіз).
Бір файл үшін мисал:
[{"%езден шыққандылық": "Иванов", "%баллы":"100"}]
Бірнеше файл үшін мисал:
[{"%езден шыққандылық": "Иванов", "%баллы":"100"}, {"%езден шыққандылық": "Петров", "%баллы":"200"}, {"%езде... аты - %filename. Жасалған файлдарды бірнеше электронды пошта адрестеріне жіберу үшін [@email] енгізу керек. Бұлда Дисктегі жіберулерінің күйініші осы адрес бойынша көрсетіледі. Тек қайта көшіргішті пайдалану керек. Әге кілтінің мәні кайталама түрде көрсетіленсе, олар қолдандырылуы керек.
Нәтиже
Сервер JSON-жолды қайтаратында келетін нәтиже келтіруі мүмкін:
-
result
Нәтиже. Келісімді қалмау мүмкін:
қателік - қалмау қателігі. Файлдар жасалмады.
сәтті - файлдарды жасау қалмауы сәтті. API пайдалану тақырыбы бойынша файлдарды сәтті жасау туралы хабарлау немесе файлдарды алу формасын көрсетуге болады. -
create_id
Жасау ID-сы. Тек сәтті іске асыруда. Басқа API-лерге келесі диалогтарда пайдалануға болады.
-
files
Жасалатын файлдардың ID-лерін ұсынады. Тек сәтті орындалуыда. JPG форматындағы мұндаи файлды алу үшін https://dimaker.app/getfile/{ID}/ бетіне өтініз. PDF файлды жүктеуге керек болса, сілтемеге pdf/ қосыңыз. API файлды түсін реттен қайтады, бірақ негізгі файл тек 1-5 секундтан кейін даярланатын уақытты талап еді. Файлды дайын болған бұрын, https://dimaker.app/getfile/{ID}/-ге қалпына келтіру 404 қатесін ұсынады.
-
url
Файлдарды алу виджетін шығару URL мәтіні. Тек сәтті іске асыруда. Бөлшем URL-ге сізге сілтемеге босу жеткізуі керек. Файлдардың орындалуы өтеуі 1 секунд + барлық топты обработкалау күтіледі күтеді. Жіберілғеннен кейін сіз көрсетілетін URL-інде Iframe ашуы мүмкін. Егер файлдар жасалмаған болса, онда соответствующее хабарлама көрсетіледі. Файлдар дауылды болып табылса, оларды жүктеуге ұсынылады. Скачивания виджетін диалогтық терезеде шыға отырып алу мүмкін. Бұрын осылайсыз: position:fixed; width:100%; height:100%; top:0; bottom:0; right:0; left:0; z-index:10000; background: rgb(0 0 0 / 72%); Сілтеме бетінде ?view=modal қосу керек. Осы iframe body-де орналасуы керек.
-
error_text
Қате болған жағдайда тек. Қате түсіндіру мәтіні. Мүмкінгі қателіктер: Дербес Secure токен, ауыстыру үшін маска, документ ID-сі, пішімнама ID-сі, Дискте файлдың ID-сі, немесе сервердің ішкі қателігі.
Сәтті өткізу мүмкіндіктерінің мисалы:
{
"result":"success",
"create_id":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"url":"https://embed.dimaker.app/widgets/get/927ebf68-2f55-4b20-a18c-c1171ee113db/b4caf05b-6757-4d9c-b4bc-1924a9b31796/",
"files":[
"369dc61e-40c2-46c0-81f4-e31ca8c33cc2",
"d94c6efb-0076-438b-bb84-fead9c1ae556",
"716e1081-c8ee-442b-b0b0-0681b2ed5d90"
]
}
Бірнеше файлдарды бір реттеу
Бір реттеу арқылы бірнеше файлдарды бір реттеу үшін файлдарды жасау қаралмайды. Осы реттеу арқылы, мисалды, орыс және ағылшын тілдеріндегі үлгіні пайдалана отырып, бірнеше файлдарды жасауға болады. Бір реттеу жіберілсе, сервер керек файлдарды жасайды.
Осы реттеу жіберу үшін doc_id айрығының массив болуы керек (адам аты - doc_id[]). Осы елдерде бір реттеуде doc_id[] күміс алуға болады - бірнеше файлдарды жасау үшін. Басқа айрықтылар, мысалы, mail_id, email_send, folder_id де массив форматта жіберіле алады, себебі өзінің файлдары күміске, белгілі уақытқа жасауға немесе белгілі қалмаған папкада сақталуға болады. Егер бұлга келмейтін болмаған болса, массив тек doc_id құлағымен болуы керек.
Мысалы, екі документтен адам айырбаста ікі файлды жасау керек және оларды Дискте айырбастау керек. Бұл үшін екі doc_id[] және екі folder_id[] (тура болатында). Сонымен қатар, оларды бір электрондық хат арқылы жіберу керек болса, онда бір mail_id көрсетіп, email_send[]-де алғашқы «manual», сонда «oncreate» көрсету қажет. Бұл жағдайда алғашқы файл жасалады, содан кейін - екінші. Сонымен жаңа жасауда белгілі mail_id хатымен жіберіледі.
Жасау кейін жіберу
Файл болуынан кейін файлды электрондық пошта атауына тікелей жіберіледі. «Хат үлгісі» түсініктісінде кімдер шаблонды қолдану үшін таңдауға болады. Бұлтарда Хат мүшелері деген жерде электрондық поштаның атауын жіберу белгішесін жасауға болады. Егер хат мәтінінде %data айрығын жазу керек болса, онда оған файлдың барлық деректері кесте шекілінде қосылады.
Файлдарды жою
Файлдарды жою үшін POST-DATA, POST-JSON немесе GET реттеулерін жіберу қажет
https://dimaker.app/api/v1/drive/files/delete/
келіп кетті. Анықталған мәлімдемелер бойынша.
Реттеудің кодтауы - UTF-8. Міндетті тұжырымдамалар жылдамыс белгіленеді.
-
сақталу*
Токен (жол, 36 символ)
-
file_id
Файл ID (жол, 36 символ), жойылатын файл. Файл ID API арқылы создатында files массивының ішіндегі файлда қайтарылады. Файл күмісте болмауы керек.
НЕМЕС
-
file_ids
Массив ID файлдар (жол, 36 символ), егер бір реттеу арқылы көп файлдар жойылатын болса.
НЕМЕС
creater_id
Өңді жасау ID (жол, 36 символ), файл API арқылы дайындалатын кезде. File_id немесе file_ids орындалған жағдайда creater_id передать болады. Осы жақта барлық өзіндік файлдар жойылады. Create_id пәрізінде файл тұғызуымен жасалған барлық файлдарды жойылады.
толық жойған
Файлды кінә жою қажет, күмісті көшіру жоқ. Әдетте файл күмістікке көшіріледі. Ұзақ кезенінде корзинаға көшіруден 60 күннен кейін автоматты түрде файлдар жоюды жасауды дайындау.
Мысал
Файлдарды жою үшін дұрыс запростың мысалы:
{
"secure":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"file_id":"369dc61e-40c2-46c0-81f4-e31ca8c33cc2"
}
Нәтиже
Сервер жауапты JSON-тізбеге қайтаратын жинағы, оның ішінде осы мүмкіндіктердің басқаулары болуы мүмкін:
-
нәтиже
Басқаулардың нәтижесі. Мүмкін болатын мәндерді алуы мүмкін:
қателік - басқауларды өшірудегі қателік. Файлдар жоқ етілмеді.
сәттілік - файлдарды жойу үшін сәтті басқаулардың өтініші. -
файлдар
Жоқ етілген файлдардың ID-ларын ұсынады. Сәттілікпен толтырылғанда тек.
-
қателік мәтіні
Қателік пайда болдығы жағдайда тек. Қателік түсіретін мәтін. Мүмкіндік қателіктер: Дұрыс Секір токені, файл ID, жасау ID-сы немесе сервердегі ішкі қателік.
Сәтті басқаулардың қайратарынан келетін мәліметтердің мысалы:
{
"нәтиже":"сәттілік",
"файлдар":["369dc61e-40c2-46c0-81f4-e31ca8c33cc2"]
}