Projects Endpoint

Endpoint route:

/pimprint-api/project/{identifier}

The plugin calls the project endpoint when a project is selected to load project settings and publications the projects can generate. The identifyer of the selected project is passed as parameter.

The response below shows a shorted example with some publications from the PimPrint-Demo when accessing a project identified by commandDemo requesting the route /pimprint-api/project/commandDemo:

{
    "formFields": {},
    "languages": [
        {
            "iso": "en",
            "label": "English"
        }
    ],
    "publications": [
        {
            "children": [],
            "identifier": "CopyBox",
            "label": "CopyBox"
        },
        {
            "children": [],
            "identifier": "ImageBox",
            "label": "ImageBox"
        }
    ],
    "success": true,
    "messages": [],
    "debugMode": false,
    "images": [],
    "settings": {}
}

The publications array withing the JSON is created by the getPublicationsTree() method implemented in project service, described in the Getting Started section.

By accessing this endpoint you can check and debug the getPublicationsTree() method for this project, delivering available publications to the Plugin. Note again the identifier key of each publication, as this will be the parameter in execute Endpoint when the Plugin requests the generation of a print product.