Skip to main content

Endpoints

/api/publication/{id}/{display}/render#

Method: POST

Request headers

PropertyValue
Content-Typeapplication/json
X-API-KeyYour API key

Request body (JSON)

PropertyDefaultRequiredComments
layers{}noTo override the properties of the layers.
connectors[]noThe list of the activated connectors for this publication. Each targeted layer should also be enabled for the connectors with the connected property.
connectorsParameters{}noTo override the connectors parameters.
returnTypebinarynoCan be binary or url.

Request body example

{
"layers": {
"matchs": {
"connected": "93ddc5eb3f5fa0db6ecb8071259a67c9"
},
"layer2": {
"property": "value"
}
},
"connectors": ["93ddc5eb3f5fa0db6ecb8071259a67c9"],
"connectorsParameters": {
"idGame": 150
}
}

Response

A binary file (image/jpeg) or an url.

/api/template/{id}/{display}/render#

Method: POST

Request headers

PropertyValue
Content-Typeapplication/json
X-API-KeyYour API key

Request body (JSON)

PropertyDefaultRequiredComments
layers{}noTo override the properties of the layers.
connectors[]noThe list of the activated connectors for this publication. Each targeted layer should also be enabled for the connectors with the connected property.
connectorsParameters{}noTo override the connectors parameters.

Request body example

{
"layers": {
"matchs": {
"connected": "93ddc5eb3f5fa0db6ecb8071259a67c9"
},
"layer2": {
"property": "value"
}
},
"connectors": ["93ddc5eb3f5fa0db6ecb8071259a67c9"],
"connectorsParameters": {
"idGame": 150
}
}

Response

A binary file (image/jpeg).