API
DiMaker API-ның қолданылуымен пайдаланушыға шын жеке мәліметтер бар файлдарды жасау және оларды төлендіру үшін беруі мүмкін. API-мен жұмыс сервердің басқа жерінен немесе CORS запрос арқылы браузерден жасалуы мүмкін.
Қалай бастауыңыз келеді
Интеграция бөлімінен «API токендері» таңбасында Қауіпсіз токенді алып, оны пайдалануға рұқсат беру керек. Окыту үшін, жеке мәліметтердің бар файлын жасау үшін және электронды пошта арқылы жіберу шаблонына және дайын файлдар үшін Дискке сәйкестендіру үшін документ жасау керек.
Файлдарды жасау
Файлдарды жасау үшін алдын-ала Data-POST немесе GET запросын жасау керек.
https://dimaker.app/api/v1/create/ адресіне мүмкіндігінше мәліметтерді көрсететін және төмендегі мәліметтерді қосудыңыз қажет. Арнайы экранның коды - UTF-8. Міндетті түрі * таңбамен белгіленген.
-
secure*
Токен (строка, 36 символ)
-
doc_id*
Файлды жасаудың мақсатында пайдаланулған Document ID (36 символдан тұруы мүмкін), документ ашылатында мекенжайда анықталады. Документ мымыры да болуы мүмкін, бірақ Документ топтарында болуы керек.
-
mask*
Барлық жергіліктерді (жергіліктігін белгілеу басқаша болмаса да) тілде белгілесетін JSON-тізімідің канша атырмалы тақырыпты элементтері бар - атырмалы тақырып(жергіліктігін білдіру) - ауыстыру үшін мәтін (мәтін сандарымен ашылуы мүмкін). Көбірек файлдарды жасау мүмкін.
Бір файлға арналған мисал:
[{"%фио": "Иванов", "%баллы": "100"}]
Бірнеше файлдарды жасау мүмкін:
[{"%фио": "Иванов", "%баллы": "100"}, {"%фио": "Петров", "%баллы": "200"}, {"%фио": "Сидоров", "%баллы": "300"}]
Электрондық поштаға мекенжай белгілеу үшін %email-ды пайдаланыңыз, файлдың атауы ішін көрсету үшін және бірнеше электрондық поштасы мен егер файлдарды декілдік тапсыру таңбасы болса, олардың бірінан кейінге ерту керек, түйінін пайдаланыңыз. Оған назар аударыңыз, тек екі тырнақшаларда қолдану қолайлы функционарлар қолдануға мүмкін. Егер белгілердің мәтіні тырнақшада белгіленсе, онда тек қайта пайдаланыла алады.Суреттің блогындағы түймелерлерге суретті жол менен (http:// немесе https://) же Base64-да кодталған сурет қосу мүмкін. Екінші жақтағы кезде тізімдің элементін маска_мен басталады мен енгізілген жердегі өзгерту құнына арналған преф
Нәтижесі
Серверден JSON-жолы аласыз, онда келесі мүмкіндіктеріңізді қабылдайды:
-
result
Өтініш нәтижесі. Келесі мүмкіндіктерін қабылдауы мүмкін:
error - өтінішқа қате. Файлдар жасалмады.
success -файлдарды жасау өтініші сәтті орындалды. API пайдалануының сценарийінен басқа, сәтті жасалған файлдар туралы хабарлау немесе файлдарды алу үшін форманы шығару мүмкін. -
create_id
Құрылу ID-сы. Қосымша өтініші сәтті орындалған кезде тек қайта пайдалануға болады.
-
files
ID-сі жасалатын файлдардың масштабы. Қосымша өтініші сәтті орындалған кезде тек. JPG пішіміндегі файлды алу үшінhttps://dimaker.app/getfile/{ID}/деректеріне өту керек. PDF файлды жүктеу үшін pdf/деректерін қосу қажет. API жасалған файлдарды түсінде қайта жазуы келетін уақыт - 1-5 секунд. Файл жасалған бұрын, https://dimaker.app/getfile/{ID}/ге өтініші 404 қатесімен жіберіледі.
-
url
Файлдарды жүктеу виджетін шығару үшін URL-тың тізбегі. Қосымша өтініші сәтті орындалған кезде. URL-ге сәйкестендірілген Iframe жасау қажет. URL-қа тек өтініш жіберу берікке толыксыз бола алады. Файлды табуға дегеніміз дұрыс анықталған API баптауларында дұрыс көрсетілу керек. Әр бір файлды жасау 1 секундаған заттық және группа бойынша өңдеу көрсетіледі. Өтініш жіберілгеннен кейін тестерлеушіже URL-ді ашуы мүмкін. Файлдар әлдеқашан жасалу аяқталмаса, оларды жүктеуге қарсы хабарлама көрсетіледі. Файлдар дайын болғаннан кейін, олар жүктеу үшін өтініш жасау.
-
error_text
Қате тек толықсыз. Кескін күтіп туралы мәтінді. Мүмкін қателер: дұрыстықтық токен, ауыстыру маскасы, документтің 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[] мәндері және біреуіншілігінен кейін айрым folder_id[] мәндері жіберілуі керек. Сондай-ақ, оларды бір пішіммен жіберуге болады, осы үшін жеке mail_id көрсету керек, email_send[] жиынтығында "manual" және "oncreate" дегенді жазыңыз. Мұнда екі файл жасалдын соң, жіберілетін post-запрос жолдары болады.
Файлды жасаудан кейін ендігуішін жіберуге болады
Файл жасалған соң, бірнеше терезеден ендігін жіберуге болады. Пішімнің «Пішінге үлгерім» жолағында ендікті пайдалануға болады. Пішіндегі үлгерімдер жолаушы қалайлы жасалатынын көре алады. Құжаттың барлық мәліметтерінің кестесі ретінде қосылған %data мәнімен пішідегі мәтін секілдегі тақырыпты.
Басқа интеграциялар
-