Skip to content

HTTPS API

Aleksey Ilyin edited this page May 26, 2023 · 13 revisions
Table of Contents

Getting data from API
Getting data from Controller

Getting data from API

API handler address: /api/v1/[..entity..]

The API can be turned on and off from the settings, you can also restrict access to the controller for anonymous users.

Since version 3.0+ supports CRUD via HTTP Methods: GET - read, POST/PUT - create, PATCH - update, DELETE - delete

Request parameters

Where [..entity..] may one of:
catalog/category, catalog/product, catalog/order, file, guestbook, page, publication, publication/category, user, user/group

In addition, you can pass request parameters in the GET string, such as: order, limit, offset, and others specific to a particular entity.

Request one

curl -X GET \
-H "Accept: application/json" \
"http://domain.com/api/v1/publication?address=blog\/zapisy-5"
{
    "status": 200,
    "params": {
        "order": [],
        "limit": 1000,
        "offset": 0,
        "address": "blog\/zapisy-5"
    },
    "data": {
        "uuid": "6b0b03af-3fde-4fac-82cc-f174aea44f1d",
        "address": "blog\/zapisy-5",
        "title": "Запись 5",
        "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
        "date": "2019-12-07 18:21:00",
        "content": {
            "short": "<p>Значимость этих проблем настолько очевидна, что начало повседневной работы по формированию позиции способствует подготовки и реализации систем массового участия. Задача организации, в особенности же реализация намеченных плановых заданий обеспечивает широкому кругу (специалистов) участие в формировании новых предложений. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности обеспечивает широкому кругу (специалистов) участие в формировании соответствующий условий активизации. Идейные соображения высшего порядка, а также сложившаяся структура организации играет важную роль в формировании систем массового участия. Не следует, однако забывать, что постоянное информационно-пропагандистское обеспечение нашей деятельности играет важную роль в формировании направлений прогрессивного развития.&nbsp;<\/p>",
            "full": "<p>Значимость этих проблем настолько очевидна, что начало повседневной работы по формированию позиции способствует подготовки и реализации систем массового участия. Задача организации, в особенности же реализация намеченных плановых заданий обеспечивает широкому кругу (специалистов) участие в формировании новых предложений. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности обеспечивает широкому кругу (специалистов) участие в формировании соответствующий условий активизации. Идейные соображения высшего порядка, а также сложившаяся структура организации играет важную роль в формировании систем массового участия. Не следует, однако забывать, что постоянное информационно-пропагандистское обеспечение нашей деятельности играет важную роль в формировании направлений прогрессивного развития.&nbsp;<\/p><p>Товарищи! рамки и место обучения кадров способствует подготовки и реализации системы обучения кадров, соответствует насущным потребностям. Равным образом постоянный количественный рост и сфера нашей активности требуют от нас анализа позиций, занимаемых участниками в отношении поставленных задач.&nbsp;<\/p><p>Разнообразный и богатый опыт дальнейшее развитие различных форм деятельности влечет за собой процесс внедрения и модернизации системы обучения кадров, соответствует насущным потребностям. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности требуют от нас анализа систем массового участия. Товарищи! дальнейшее развитие различных форм деятельности влечет за собой процесс внедрения и модернизации форм развития. Идейные соображения высшего порядка, а также рамки и место обучения кадров обеспечивает широкому кругу (специалистов) участие в формировании существенных финансовых и административных условий. Не следует, однако забывать, что укрепление и развитие структуры в значительной степени обуславливает создание системы обучения кадров, соответствует насущным потребностям. Повседневная практика показывает, что укрепление и развитие структуры требуют определения и уточнения модели развития.<\/p>"
        },
        "poll": {
            "question": "",
            "answer": ""
        },
        "meta": {
            "title": "",
            "description": "",
            "keywords": ""
        },
        "files": []
    }
}

Request list

curl -X GET \
-H "Accept: application/json" \
"http://domain.com/api/v1/file?limit=5"
{
    "status": 200,
    "params": {
        "order": [],
        "limit": "5",
        "offset": 0
    },
    "data": [
        {
            "name": "leo_pride_2000481002481_images_9395573817.jpg",
            "size": 30285,
            "path": {
                "full": "\/uploads\/5de64c429f320\/leo_pride_2000481002481_images_9395573817.jpg",
                "middle": "\/uploads\/5de64c429f320\/middle\/leo_pride_2000481002481_images_9395573817.jpg",
                "small": "\/uploads\/5de64c429f320\/small\/leo_pride_2000481002481_images_9395573817.jpg"
            }
        },
        {
            "name": "leo_pride_2000481002481_images_9395571353.jpg",
            "size": 27478,
            "path": {
                "full": "\/uploads\/5de64c4285c50\/leo_pride_2000481002481_images_9395571353.jpg",
                "middle": "\/uploads\/5de64c4285c50\/middle\/leo_pride_2000481002481_images_9395571353.jpg",
                "small": "\/uploads\/5de64c4285c50\/small\/leo_pride_2000481002481_images_9395571353.jpg"
            }
        },
        {
            "name": "riccardo_roz6205086399_images_11320272762.jpg",
            "size": 64364,
            "path": {
                "full": "\/uploads\/5de8d58072611\/riccardo_roz6205086399_images_11320272762.jpg",
                "middle": "\/uploads\/5de8d58072611\/middle\/riccardo_roz6205086399_images_11320272762.jpg",
                "small": "\/uploads\/5de8d58072611\/small\/riccardo_roz6205086399_images_11320272762.jpg"
            }
        },
        {
            "name": "fashionup_2100000122295_images_14553220161.jpg",
            "size": 56691,
            "path": {
                "full": "\/uploads\/5de64cee1b580\/fashionup_2100000122295_images_14553220161.jpg",
                "middle": "\/uploads\/5de64cee1b580\/middle\/fashionup_2100000122295_images_14553220161.jpg",
                "small": "\/uploads\/5de64cee1b580\/small\/fashionup_2100000122295_images_14553220161.jpg"
            }
        },
        {
            "name": "mila_nova_mila2000000018331_images_13739275273.jpg",
            "size": 21885,
            "path": {
                "full": "\/uploads\/5de56c8e663fc\/mila_nova_mila2000000018331_images_13739275273.jpg",
                "middle": "\/uploads\/5de56c8e663fc\/middle\/mila_nova_mila2000000018331_images_13739275273.jpg",
                "small": "\/uploads\/5de56c8e663fc\/small\/mila_nova_mila2000000018331_images_13739275273.jpg"
            }
        }
    ]
}

Getting data from Controller

Each commoncontroller can send values in json format, just add ?format=json in address line.

For example publications list: /blog?format=json

{
    "params": {
        "format": "json"
    },
    "data": {
        "categories": [
            {
                "uuid": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "address": "blog",
                "title": "Блог",
                "description": "",
                "parent": "00000000-0000-0000-0000-000000000000",
                "pagination": 5,
                "children": true,
                "public": true,
                "sort": {
                    "by": "date",
                    "direction": "DESC"
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "template": {
                    "list": "publication.list.twig",
                    "short": "publication.short.twig",
                    "full": "publication.full.twig"
                },
                "files": []
            }
        ],
        "category": {
            "uuid": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
            "address": "blog",
            "title": "Блог",
            "description": "",
            "parent": "00000000-0000-0000-0000-000000000000",
            "pagination": 5,
            "children": true,
            "public": true,
            "sort": {
                "by": "date",
                "direction": "DESC"
            },
            "meta": {
                "title": "",
                "description": "",
                "keywords": ""
            },
            "template": {
                "list": "publication.list.twig",
                "short": "publication.short.twig",
                "full": "publication.full.twig"
            },
            "files": []
        },
        "publications": [
            {
                "uuid": "6f718076-b2c0-43aa-9ecc-8f05eb624f6b",
                "address": "blog\/zapisy-1",
                "title": "Запись 1",
                "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "date": "2019-12-08 04:19:00",
                "content": {
                    "short": "<p>Разнообразный и богатый опыт постоянный количественный рост и сфера нашей активности играет важную роль в формировании дальнейших направлений развития. Повседневная практика показывает, что постоянный количественный рост и сфера нашей активности играет важную роль в формировании позиций, занимаемых участниками в отношении поставленных задач.&nbsp;<\/p>",
                    "full": "<p>Разнообразный и богатый опыт постоянный количественный рост и сфера нашей активности играет важную роль в формировании дальнейших направлений развития. Повседневная практика показывает, что постоянный количественный рост и сфера нашей активности играет важную роль в формировании позиций, занимаемых участниками в отношении поставленных задач.&nbsp;<\/p><p>Товарищи! реализация намеченных плановых заданий играет важную роль в формировании существенных финансовых и административных условий. Задача организации, в особенности же реализация намеченных плановых заданий позволяет оценить значение форм развития. Повседневная практика показывает, что сложившаяся структура организации обеспечивает широкому кругу (специалистов) участие в формировании соответствующий условий активизации. Таким образом укрепление и развитие структуры требуют определения и уточнения новых предложений.&nbsp;<\/p><p>Разнообразный и богатый опыт консультация с широким активом требуют от нас анализа форм развития. Таким образом постоянное информационно-пропагандистское обеспечение нашей деятельности представляет собой интересный эксперимент проверки дальнейших направлений развития.<\/p>"
                },
                "poll": {
                    "question": "",
                    "answer": ""
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "files": []
            },
            {
                "uuid": "6b8130ad-ae13-41fe-9c33-fc3c965856e6",
                "address": "blog\/zapisy-6",
                "title": "Запись 6",
                "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "date": "2019-12-07 21:21:00",
                "content": {
                    "short": "<p>Товарищи! дальнейшее развитие различных форм деятельности требуют от нас анализа системы обучения кадров, соответствует насущным потребностям. С другой стороны сложившаяся структура организации требуют от нас анализа системы обучения кадров, соответствует насущным потребностям. Таким образом постоянный количественный рост и сфера нашей активности играет важную роль в формировании форм развития.&nbsp;<\/p>",
                    "full": "<p>Товарищи! дальнейшее развитие различных форм деятельности требуют от нас анализа системы обучения кадров, соответствует насущным потребностям. С другой стороны сложившаяся структура организации требуют от нас анализа системы обучения кадров, соответствует насущным потребностям. Таким образом постоянный количественный рост и сфера нашей активности играет важную роль в формировании форм развития.&nbsp;<\/p><p>Разнообразный и богатый опыт укрепление и развитие структуры влечет за собой процесс внедрения и модернизации существенных финансовых и административных условий. С другой стороны постоянное информационно-пропагандистское обеспечение нашей деятельности играет важную роль в формировании позиций, занимаемых участниками в отношении поставленных задач. Не следует, однако забывать, что постоянный количественный рост и сфера нашей активности влечет за собой процесс внедрения и модернизации позиций, занимаемых участниками в отношении поставленных задач. Товарищи! новая модель организационной деятельности требуют определения и уточнения модели развития. Не следует, однако забывать, что рамки и место обучения кадров в значительной степени обуславливает создание существенных финансовых и административных условий. Повседневная практика показывает, что постоянный количественный рост и сфера нашей активности играет важную роль в формировании позиций, занимаемых участниками в отношении поставленных задач.&nbsp;<\/p><p>Повседневная практика показывает, что реализация намеченных плановых заданий способствует подготовки и реализации системы обучения кадров, соответствует насущным потребностям. Повседневная практика показывает, что сложившаяся структура организации представляет собой интересный эксперимент проверки новых предложений.<\/p>"
                },
                "poll": {
                    "question": "",
                    "answer": ""
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "files": []
            },
            {
                "uuid": "6b0b03af-3fde-4fac-82cc-f174aea44f1d",
                "address": "blog\/zapisy-5",
                "title": "Запись 5",
                "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "date": "2019-12-07 18:21:00",
                "content": {
                    "short": "<p>Значимость этих проблем настолько очевидна, что начало повседневной работы по формированию позиции способствует подготовки и реализации систем массового участия. Задача организации, в особенности же реализация намеченных плановых заданий обеспечивает широкому кругу (специалистов) участие в формировании новых предложений. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности обеспечивает широкому кругу (специалистов) участие в формировании соответствующий условий активизации. Идейные соображения высшего порядка, а также сложившаяся структура организации играет важную роль в формировании систем массового участия. Не следует, однако забывать, что постоянное информационно-пропагандистское обеспечение нашей деятельности играет важную роль в формировании направлений прогрессивного развития.&nbsp;<\/p>",
                    "full": "<p>Значимость этих проблем настолько очевидна, что начало повседневной работы по формированию позиции способствует подготовки и реализации систем массового участия. Задача организации, в особенности же реализация намеченных плановых заданий обеспечивает широкому кругу (специалистов) участие в формировании новых предложений. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности обеспечивает широкому кругу (специалистов) участие в формировании соответствующий условий активизации. Идейные соображения высшего порядка, а также сложившаяся структура организации играет важную роль в формировании систем массового участия. Не следует, однако забывать, что постоянное информационно-пропагандистское обеспечение нашей деятельности играет важную роль в формировании направлений прогрессивного развития.&nbsp;<\/p><p>Товарищи! рамки и место обучения кадров способствует подготовки и реализации системы обучения кадров, соответствует насущным потребностям. Равным образом постоянный количественный рост и сфера нашей активности требуют от нас анализа позиций, занимаемых участниками в отношении поставленных задач.&nbsp;<\/p><p>Разнообразный и богатый опыт дальнейшее развитие различных форм деятельности влечет за собой процесс внедрения и модернизации системы обучения кадров, соответствует насущным потребностям. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности требуют от нас анализа систем массового участия. Товарищи! дальнейшее развитие различных форм деятельности влечет за собой процесс внедрения и модернизации форм развития. Идейные соображения высшего порядка, а также рамки и место обучения кадров обеспечивает широкому кругу (специалистов) участие в формировании существенных финансовых и административных условий. Не следует, однако забывать, что укрепление и развитие структуры в значительной степени обуславливает создание системы обучения кадров, соответствует насущным потребностям. Повседневная практика показывает, что укрепление и развитие структуры требуют определения и уточнения модели развития.<\/p>"
                },
                "poll": {
                    "question": "",
                    "answer": ""
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "files": []
            },
            {
                "uuid": "e0f8ce8a-61f7-4d4a-ba8d-138b8e92c313",
                "address": "blog\/zapisy-4",
                "title": "Запись 4",
                "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "date": "2019-12-07 18:21:00",
                "content": {
                    "short": "<p>Задача организации, в особенности же сложившаяся структура организации обеспечивает широкому кругу (специалистов) участие в формировании модели развития. Не следует, однако забывать, что постоянный количественный рост и сфера нашей активности в значительной степени обуславливает создание соответствующий условий активизации. Равным образом сложившаяся структура организации играет важную роль в формировании модели развития. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности позволяет выполнять важные задания по разработке систем массового участия. Идейные соображения высшего порядка, а также начало повседневной работы по формированию позиции требуют определения и уточнения новых предложений.&nbsp;<\/p>",
                    "full": "<p>Задача организации, в особенности же сложившаяся структура организации обеспечивает широкому кругу (специалистов) участие в формировании модели развития. Не следует, однако забывать, что постоянный количественный рост и сфера нашей активности в значительной степени обуславливает создание соответствующий условий активизации. Равным образом сложившаяся структура организации играет важную роль в формировании модели развития. Разнообразный и богатый опыт постоянное информационно-пропагандистское обеспечение нашей деятельности позволяет выполнять важные задания по разработке систем массового участия. Идейные соображения высшего порядка, а также начало повседневной работы по формированию позиции требуют определения и уточнения новых предложений.&nbsp;<\/p><p>Не следует, однако забывать, что рамки и место обучения кадров способствует подготовки и реализации позиций, занимаемых участниками в отношении поставленных задач. Товарищи! реализация намеченных плановых заданий позволяет оценить значение позиций, занимаемых участниками в отношении поставленных задач. Равным образом начало повседневной работы по формированию позиции влечет за собой процесс внедрения и модернизации системы обучения кадров, соответствует насущным потребностям.&nbsp;<\/p><p>Таким образом дальнейшее развитие различных форм деятельности позволяет выполнять важные задания по разработке дальнейших направлений развития. Равным образом новая модель организационной деятельности играет важную роль в формировании системы обучения кадров, соответствует насущным потребностям.<\/p>"
                },
                "poll": {
                    "question": "",
                    "answer": ""
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "files": []
            },
            {
                "uuid": "c79cb655-5ce9-4038-bc5f-30ff08eb3c8f",
                "address": "blog\/zapisy-3",
                "title": "Запись 3",
                "category": "092c3aca-d142-4b97-9b8e-32f4ed7a77a9",
                "date": "2019-12-07 18:20:00",
                "content": {
                    "short": "<p>Разнообразный и богатый опыт новая модель организационной деятельности требуют от нас анализа новых предложений. Таким образом консультация с широким активом влечет за собой процесс внедрения и модернизации существенных финансовых и административных условий. Равным образом новая модель организационной деятельности позволяет выполнять важные задания по разработке систем массового участия. Значимость этих проблем настолько очевидна, что постоянное информационно-пропагандистское обеспечение нашей деятельности требуют от нас анализа позиций, занимаемых участниками в отношении поставленных задач. Разнообразный и богатый опыт дальнейшее развитие различных форм деятельности обеспечивает широкому кругу (специалистов) участие в формировании существенных финансовых и административных условий. Задача организации, в особенности же дальнейшее развитие различных форм деятельности требуют определения и уточнения систем массового участия.&nbsp;<\/p>",
                    "full": "<p>Разнообразный и богатый опыт новая модель организационной деятельности требуют от нас анализа новых предложений. Таким образом консультация с широким активом влечет за собой процесс внедрения и модернизации существенных финансовых и административных условий. Равным образом новая модель организационной деятельности позволяет выполнять важные задания по разработке систем массового участия. Значимость этих проблем настолько очевидна, что постоянное информационно-пропагандистское обеспечение нашей деятельности требуют от нас анализа позиций, занимаемых участниками в отношении поставленных задач. Разнообразный и богатый опыт дальнейшее развитие различных форм деятельности обеспечивает широкому кругу (специалистов) участие в формировании существенных финансовых и административных условий. Задача организации, в особенности же дальнейшее развитие различных форм деятельности требуют определения и уточнения систем массового участия.&nbsp;<\/p><p>Идейные соображения высшего порядка, а также рамки и место обучения кадров влечет за собой процесс внедрения и модернизации форм развития. Товарищи! начало повседневной работы по формированию позиции обеспечивает широкому кругу (специалистов) участие в формировании систем массового участия. Повседневная практика показывает, что реализация намеченных плановых заданий способствует подготовки и реализации форм развития.&nbsp;<\/p><p>Задача организации, в особенности же сложившаяся структура организации представляет собой интересный эксперимент проверки позиций, занимаемых участниками в отношении поставленных задач. С другой стороны новая модель организационной деятельности обеспечивает широкому кругу (специалистов) участие в формировании модели развития. Таким образом консультация с широким активом требуют определения и уточнения новых предложений. Значимость этих проблем настолько очевидна, что дальнейшее развитие различных форм деятельности способствует подготовки и реализации системы обучения кадров, соответствует насущным потребностям.<\/p>"
                },
                "poll": {
                    "question": "",
                    "answer": ""
                },
                "meta": {
                    "title": "",
                    "description": "",
                    "keywords": ""
                },
                "files": []
            }
        ],
        "pagination": {
            "count": 6,
            "page": 5,
            "offset": 0
        }
    }
}