Мүмкүнчүлүктөр Кыймылсыз мүлк Документация Биз жөнүндө Веб-тиркемени ачуу

API

Документация машиналык үйрөнүүнү колдонуу аркылуу автоматтык которулган.

DiMaker API колдонуп, жеке маалыматтар менен файлдарды түзсө болот жана зарыл учурда аларды алуучуларга бере аласыз. APIге суроо камтылган түйүнгө жөнөтүлүшү мүмкүн же браузерден CORS сурамасы аркылуу жөнөтүлүшү мүмкүн.

Башталгыч кадамдар

«Интеграция» - «API Токендер» бөлүмүндө API сурамдары үчүн Коопсуз токен алып, анын колдонулушун иштетиш керек. Ошондой эле, жеке маалыматтар үчүн өзгөрмөлөрдү камтыган документти, электрондук почта аркылуу таратылуучу каттын шаблонун жана даяр файлдар үчүн этоже Дискте папканы түзүү зарыл.

Файлдарды түзүү

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

  • secure*

    Токен (түзүлүш, 36 символ)

  • doc_id*

    Документтин IDсы (түзүлүш, 36 символ), файлды түзүү үчүн колдонулат. IDны документ ачылганда адрес сабында алууга болот. Документ себетте болбошу керек, бирок Документтер папкасындагы каалаган папкаларда сакталса болот.

  • mask*

    Бардык өзгөрүлгөн кысымы - мааниси (алмашыс үчүн текст) катары JSON-түзүлүшү. Бир нече файл түзүү үчүн маалыматтарды камтыйт (сан боюнча чектөөлөр жок).
    Бир файл үчүн мисал:
    [{"%name": "Иванов", "%баллы":"100"}]
    Бир нече файл үчүн мисал:
    [{"%name": "Иванов", "%баллы":"100"}, {"%name": "Петров", "%баллы":"200"}, {"%name": "Сидоров", "%баллы":"300"}]
    Электрондук почтанын дарегин көрсөтүү үчүн %email, файлдын атын көрсөтүү үчүн %filename колдонуу керек. Бир нече электрондук почта даректерге жөнөтүлгөн файлдардын анкетасы биринчи дарек бузулат. Адекват алуу үчүн стандартка дал келген кошумча кавычкалар гана колдонулушу керек. Эгер ачкыч маанилары кавычкаларды камтыса, алар экранизаравор болушу керек.

    Сүрөт блогуна сүрөттү берүү үчүн түз шилтемени колдонсо болот (http:// же https://), же Base64 аркылуу коддолгон сүрөттү. Экинчисинде текст "data:image/" деп башталуусу керек.

    Альтернативный метод
    Эгер JSON-текст жөнөтө албасаңыз, алмашуу үчүн тексттер талап катарында жөнөтүлүшү мүмкүн. Талаа алмаштырыла турган өзгөрмөлүү префикс менен башталуусу керек, мисалы mask_name жана алмаштыруу үчүн маанини камтышы керек. Бул учурда документте префикс боюнча өзгөрмө издетиши болот. Мисалы, mask_name талаасы %name өзгөрмөсүнө дал келет. Электрондук почтануу баанын дарегин көрсөтүү үчүн mask_email, файлдын атын аныктоо үчүн mask_filename колдонулушу керек.

  • mail_id

    Электрондук каттын шаблону IDсы (түзүлүш, 36 символ) электрондук почта аркылуу жөнөтүү үчүн. Шаблон ачылганда IDны адрес сабында алууга болот. Үлгү жөнөтүлгөн эмес болсо, катка жөнөтүлбөйт.

  • email_send

    Файл менен кат жөнөтүү убактысы. Униф айрым белгилер:
    onfinish - Файлдар түзүлгөндөн кийин бардык каттарды жөнөт (кошулуп алынган)
    oncreate - Файл түзүлгөндөн кийин дароо каттарды жөнөт. Бир файл түзүлгүдө onfinish жана oncreate колдонуу окшош.
    timeout - Өзгөчө убакыт түгүнүн ичинде каттарды жөнөт. Бул учурда эки коштоолор берилүү керек:
    email_timeout_value - кат жөнөтүү үчүн убакыт түшүнүгү, бүтүн сана
    email_timeout_unit - убакыт өлчөм бирлиги. "m" (мүнөт), "h" (саат), "d" (күндөр) маанисин алышы мүмкүн.
    Так жөнөтүү убакытын көрсөтүү үчүн unix time түрүндө email_timeout_timestamp убактысын берүү керек. Эгер email_timeout_value жана email_timeout_timestamp берилсе, соңкусу мааниге ээ болот.

  • folder_id

    Файлдардын сакталуучу Дисктеги папка IDсы (түзүлүш, 36 символ). Папка жок болсо, ал автоматтык түрдө биринчи файл түзүлгөндө түзүлөт.

  • storage_period

    Файлдардын Дискте сактоо мөөнөтү. Эгер көрсөтүлгөн эмес болсо, файлдар чексиз сакталат, кол менен өчүрүүгө чейин. Эгер убакыт колдонуу керек болсо, булар болушу керек
    timeout. Мында кошумча эки параметр көрсөтуу керек:
       storage_period_timeout_value - файлдарды өчүрүү үчүн орун алган аралыктык түшүнүгү, бүтүн мааниси
       storage_period_timeout_unit - аралыктык түшүнүгүн өлчөм бирлиги. "m" (мүнөт), "h" (саат), "d" (күндөр) маанисин алышы мүмкүн.
    Так кыскартуусун көрсөтүү үчүн exact time түрүндө storage_period_timeout_timestamp убактысын берүү керек. Эгер булар storage_period_timeout_value жана email_timeout_timestamp болсо, соңкусу мааниге ээ болот.

  • page_id

    Кээде бет кол тамгасы (сан же түзүлүш), эгер документте көптөгөн беттер бар болсо. Бир номер (биринчи бет - 0) же номерштер (үтүктөрдөн ичинен) файла түзүү үчүн колдонуу керек.

  • result

    Жыйынтыгы кандай түрдө кайтаруу керектигин аныктайт. Бул маанилерди алышы мүмкүн:

    • Значение отсутствует. Сурамдын жыйынтыгы JSON-түзүлүшү катары кайтарылат (төмөн көр).
    • link. Ийгилик суроо менен түзүлгөн файлга шилтеме берүүчү текст кайтарылат (эгер көпчүлүк файлдар түзүлгөн болсо, биринчиси жөнүндө шилтеме). Кариб эң төмөнкү кайруу үчүн, көрсөтүлгөн шилтемени колдонушуңуз керек. Файлдын өзүн түзүүгө убакыт керек - ар бир файл үчүн 1ден 5 секундга чейин. Файл түзүлгөнгө чейин, бул URLге суроо 404 катасын кайтарат. Эгер суроо файл түзүүгө алып келбесе, анда катасы бар JSON-текст келтирилген болот (төмөн көр).
    • файл. Ийгилик суроо менен түзүлгөн өз даяр файл кайтарылат (эгерде суроо көп файлдарды түзүү үчүн жөнөтүлсө, анда бир гана файлы). Файл түзүүгө 1-5 секунд талап кылынгандыктан, кайтаруу бышыруу бүткөндөн кийин гана болот. Файлды даярдоо үчүн 30 секунд убакыт керек, анда API 404 катасын кайтарат, бирок суроо акыр аягында аткарылат. Эгерде суроолордун саны көп алышы мүмкүн болсо, анда бул параметрди колдонуунун орду жок.

Жыйынтык

Кыйын болду манжа мени мыйын кол баш керек кайтарат JSON-түзүлүшү, төмөнкү мүмкүн болгон маанилерди алышы мүмкүн:

Баштоого даярсызбы?

Ачуу Веб-тиркемени ачуу