API Configuration
Creation
Request
POST
https://phoenix.stg.webout.io/templatescurl --location 'https://phoenix.stg.webout.io/templates' \
--header 'Content-Type: application/json' \
--data '{
"templateData": {
"slug": "sablona",
"scenes": [
{
"slug": "PACKSHOT",
"content": [
{
"slug": "background",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bg_datart.png"
}
}
},
{
"slug": "pruh",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bar_datart.png"
}
}
},
{
"slug": "produkt",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/product_datart.png"
}
}
},
{
"slug": "název",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "Mobilní telefon Apple iPhone 13 128GB Starlight (MLPG3CN/A)"
}
}
},
{
"slug": "cena",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "center",
"text": "16,990 CZK"
}
}
},
{
"slug": "doprava",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "100 CZK left for free shipping"
}
}
},
{
"slug": "logo",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/logo_datart.png"
}
}
},
{
"slug": "sleva-grafika",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/discount_datart.png"
}
}
},
{
"slug": "sleva-cislo",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "50%"
}
}
},
{
"slug": "sleva-text",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "discount"
}
}
}
]
}
]
}
}'
Response
{
"_id": "66683b4a864c93f146c34a0e",
"templateData": {
...
}
"updatedAt": "2024-06-11T11:55:54.860Z",
"createdAt": "2024-06-11T11:55:54.860Z",
"deletedAt": null,
"__v": 0
}
Payload:
- Name
_id- Type
- string
- Description
Configuration UUID
- Name
templateData- Type
- object
- Description
Complete configuration settings information
- Name
slug- Type
- string
- Description
Project slug used as the basis for the configuration
- Name
scenes- Type
- array
- Description
Array of scenes in the configuration
- Name
slug- Type
- string
- Description
Scene slug
- Name
content- Type
- string
- Description
Array of contents within the scene
Response:
- Name
configuration_uuid- Type
- string
- Description
Configuration UUID
- Name
templateData- Type
- object
- Description
Complete configuration settings information that is stored
Retrieval
Request
GET
https://phoenix.stg.webout.io/templates/:UUIDcurl --location 'https://phoenix.stg.webout.io/templates/66683b4a864c93f146c34a0e' \
--header 'Content-Type: application/json' \
--data ''
Response
{
"_id": "66683b4a864c93f146c34a0e",
"templateData": {
"slug": "sablona",
"scenes": [
{
"slug": "PACKSHOT",
"content": [
{
"slug": "background",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bg_datart.png"
}
}
},
{
"slug": "pruh",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bar_datart.png"
}
}
},
{
"slug": "produkt",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/product_datart.png"
}
}
},
{
"slug": "název",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "Mobile Phone Apple iPhone 13 128GB Starlight (MLPG3CN/A)"
}
}
},
{
"slug": "cena",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "center",
"text": "16,990 CZK"
}
}
},
{
"slug": "doprava",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "100 CZK left for free shipping"
}
}
},
{
"slug": "logo",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/logo_datart.png"
}
}
},
{
"slug": "sleva-grafika",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/discount_datart.png"
}
}
},
{
"slug": "sleva-cislo",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "50%"
}
}
},
{
"slug": "sleva-text",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "discount"
}
}
}
]
}
]
},
"deletedAt": null,
"updatedAt": "2024-06-11T11:55:54.860Z",
"createdAt": "2024-06-11T11:55:54.860Z",
"__v": 0
}
Query:
- Name
configuration_uuid- Type
- string
- Description
Configuration UUID
Response:
- Name
_id- Type
- string
- Description
Configuration UUID
- Name
templateData- Type
- object
- Description
Complete configuration settings information
- Name
slug- Type
- string
- Description
Project slug based on which the configuration is created
- Name
scenes- Type
- array
- Description
Array of individual scenes in the configuration
- Name
slug- Type
- string
- Description
Scene slug
- Name
content- Type
- string
- Description
Array of individual contents within the scene
Update
Request
PUT
https://phoenix.stg.webout.io/templates/:UUIDcurl --location 'https://phoenix.stg.webout.io/templates/66683b4a864c93f146c34a0e' \
--header 'Content-Type: application/json' \
--data '{
"templateData": {
"slug": "sablona",
"scenes": [
{
"slug": "PACKSHOT",
"content": [
{
"slug": "background",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bg_datart.png"
}
}
},
{
"slug": "pruh",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/bar_datart.png"
}
}
},
{
"slug": "produkt",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/product_datart.png"
}
}
},
{
"slug": "název",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "Mobile Phone Apple iPhone 13 128GB Starlight (MLPG3CN/A)"
}
}
},
{
"slug": "cena",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "center",
"text": "16,990 CZK"
}
}
},
{
"slug": "doprava",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#ffffff",
"fontSize": 100,
"align": "left",
"text": "100 CZK left for free shipping"
}
}
},
{
"slug": "logo",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/logo_datart.png"
}
}
},
{
"slug": "sleva-grafika",
"source": {
"data": {
"src": "https://phoenix.dev.webout.io/uploads/templates/images/discount_datart.png"
}
}
},
{
"slug": "sleva-cislo",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "50%"
}
}
},
{
"slug": "sleva-text",
"source": {
"data": {
"fontFamily": "din_2014_bold",
"color": "#000000",
"fontSize": 100,
"align": "center",
"text": "discount"
}
}
}
]
}
]
}
}'
Response
{
"_id": "66683b4a864c93f146c34a0e",
"templateData": {
...
}
"updatedAt": "2024-06-12T11:55:54.860Z",
"createdAt": "2024-06-11T11:55:54.860Z",
"deletedAt": null,
"__v": 0
}
Payload:
- Name
_id- Type
- string
- Description
Configuration UUID
- Name
templateData- Type
- object
- Description
Complete configuration settings information
- Name
slug- Type
- string
- Description
Project slug based on which the configuration is created
- Name
scenes- Type
- array
- Description
Array of individual scenes in the configuration
- Name
slug- Type
- string
- Description
Scene slug
- Name
content- Type
- string
- Description
Array of individual contents within the scene
Response:
- Name
configuration_uuid- Type
- string
- Description
Configuration UUID
- Name
templateData- Type
- object
- Description
Updated configuration data that has been saved
Deletion
Request
DELETE
https://phoenix.stg.webout.io/templates/:UUIDcurl --location 'https://phoenix.stg.webout.io/templates/66683b4a864c93f146c34a0e' \
--header 'Content-Type: application/json' \
--data ''
Response
{}
Query:
- Name
configuration_uuid- Type
- string
- Description
Configuration UUID
Response:
- Name
status- Type
- number
- Description
Status 204 confirms successful deletion of the configuration