 API

DiMaker API қолдану арқылы дербестендірілген мәліметтері бар файлдарды жасап, қажет болған жағдайда оларды алушыларға жіберуге болады. API-ге сұраулар басқа серверден де, CORS сұранысы арқылы браузерден де жіберілуі мүмкін.

Қалай бастау керек

«Интеграция» - «API токендері» бөлімінде Secure токенін алып, оны қолдануға рұқсат беру керек. Сонымен қатар, дербес мәліметтер үшін айнымалылармен құжатты, электрондық пошта арқылы жіберу үшін хат шаблонын және дайын файлдар үшін Дискке арналған қалта құру қажет.

Файлдарды жасау

Файлдарды жасау үшін төменде көрсетілген мәліметтермен
https://dimaker.app/api/v1/create/
мекенжайына POST-DATA, POST- немесе GET сұрауларын жіберу қажет.
Сұрау кодировкасы - UTF-8. Міндетті өрістер жұлдызшамен белгіленген.

• secure*

  Токен (жолақ, 36 символ)

• doc_id*

  Жасалатын файл үшін пайдаланылатын құжаттың ID-і (жолақ, 36 символ). Құжат ашылған кездегі мекенжай жолынан ID алуға болады. Құжат себетте болмауы тиіс, бірақ құжаттар қалтасының ішінде орналасуы мүмкін.

• mask*

  Мәтінді орын ауыстыруға арналған айнымалы мәндерін қамтитын -жолақ. Бір файл үшін мысал:
  [{"%name": "Иванов", "%баллы":"100"}]
  Бірнеше файлдарға:
  [{"%name": "Иванов", "%баллы":"100"}, {"%name": "Петров", "%баллы":"200"}, {"%name": "Сидоров", "%баллы":"300"}]
  Электрондық пошта мекенжайын ұсыну үшін %email, файл атауы үшін %filename пайдаланылады. Екілік жағдайларда Base64 көмегімен деректерді тасымалдауға болады.

  Альтернативті әдіс
  Егер -жолақ жіберу мүмкін болмаса, айнымалыларды сұрауда mask_ префиксімен бірге жіберуге болады. Мысалы, mask_name айнымалысы %name сәйкес болады.

• mail_id

  Электрондық пошта үлгісінің ID-і (жолақ, 36 символ). Үлгі ашық болған кездегі мекенжай жолынан ID алуға болады. Переменная жоқ болса, хат жіберілмейді.

• email_send

  Файл қосылған хатты жіберу уақыты. Мүмкін мәндер:
  onfinish - Барлық файлдар дайын болғаннан кейін хат жіберіледі (әдепкі бойынша)
  oncreate - Файл жасалған сайын бірден хат жіберіледі.
  timeout - Белгілі бір уақыт аралығында хат жіберу үшін пайдаланушы параметрлерді толтыруы тиіс.

• folder_id

  Файлдарды сақтау үшін диск қалтасының ID-і (жолақ, 36 символ). Егер мұндай қалта жоқ болса, ол бірінші файл жасалғанда автоматты түрде құрылады.

• page_id

  Құжаттың ішіндегі бет нөмірі, егер онда бірнеше бет бар болса. Біріншісі - 0.

• result

  Нәтижені қай түрде қайтаратынын анықтайды. Мәндер:

  • Мән жоқ. -жолақ нәтижесі қайтарылады.
  • link. Құрылған файлға сілтеме қайтарылады.
  • file. Дайын файл қайтарылады.

Нәтиже

Сервер нәтижесінде келесі -жолақ мәнін қайтарады:

• result

  Ұсыныс нәтижесі. Мүмкін мәндер:
  error - Ұсыныс қатесі.
  success - Файлдарды сәтті жасау.

• create_id

  Генерация ID-і. API ұсыныстары үшін қажет болуы мүмкін.

• files

  Жасалған файлдардың ID-лерін қамтитын массив. Мысал келтірілген.

• url

  Файлдарды жүктеу виджетіне арналған URL.

• error_text

  Қате болған жағдайда, оның сипаттамасы берілген.

Басқа интеграциялар