Site web
Arborescence
Liste les menus GET
/v1/sites/{code_site}/cms/menus.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:[
{
"menu_id": "integer",
"name": "string",
"is_main": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"pages": [
{
"page_id": "integer",
"menu_id": "integer",
"page_type": "string",
"page_parent_id": "integer",
"name": "string",
"is_visible": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"slug": "string",
"has_restrictions": "boolean",
"restrictions": "List",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List",
"target_type": "string",
"target_page": "string",
"target_key": "string",
"target_name": "string",
"link_attributs": "string",
"link_xtra": "string",
"link_description": "string",
"link_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"url": "string",
"url_target": "string"
}
],
"api_key": "string"
}
]| Nom | Type | Description |
|---|---|---|
menu_id | integer | Identifiant du menu |
name | string | Intitulé du menu |
is_main | boolean | Menu principal |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
pagesFacultatif | object | Listes des pages |
page_id | integer | Identifiant de la page |
menu_id | integer | Identifiant du menu de la page |
page_type | string | Type de page. Les valeurs possibles sont : page, internal_link, external_link, separator |
page_parent_id | integer | Identifiant de la page parente |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
slugFacultatif | string | Nom optimisé |
has_restrictionsFacultatif | boolean | En accès restreint |
restrictionsFacultatif | List | Accès extranet |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
target_typeFacultatif | string | Type de catégorie du lien interne |
target_pageFacultatif | string | Type de page de la cible |
target_keyFacultatif | string | Identifiant de la page cible |
target_nameFacultatif | string | Intitulé de la page cible |
link_attributsFacultatif | string | Attributs du lien interne |
link_xtraFacultatif | string | Extra du lien interne |
link_descriptionFacultatif | string | Description du lien interne |
link_imageFacultatif | object | Image du lien interne |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
urlFacultatif | string | Url du lien externe |
url_targetFacultatif | string | Cible du lien externe |
api_key | string | Clé API du dossier |
Ajoute un menu POST
/v1/sites/{code_site}/cms/menus.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
name | string | Intitulé du menu | |
Format de sortie :
data:[]| Nom | Type | Description |
|---|
Détail d'un menu GET
/v1/sites/{code_site}/cms/menus/{menu_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
menu_id | Obligatoire | integer | Identifiant du menu | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:{
"menu_id": "integer",
"name": "string",
"is_main": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"pages": [
{
"page_id": "integer",
"menu_id": "integer",
"page_type": "string",
"page_parent_id": "integer",
"name": "string",
"is_visible": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"slug": "string",
"has_restrictions": "boolean",
"restrictions": "List",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List",
"target_type": "string",
"target_page": "string",
"target_key": "string",
"target_name": "string",
"link_attributs": "string",
"link_xtra": "string",
"link_description": "string",
"link_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"url": "string",
"url_target": "string"
}
],
"api_key": "string"
}| Nom | Type | Description |
|---|---|---|
menu_id | integer | Identifiant du menu |
name | string | Intitulé du menu |
is_main | boolean | Menu principal |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
pagesFacultatif | object | Listes des pages |
page_id | integer | Identifiant de la page |
menu_id | integer | Identifiant du menu de la page |
page_type | string | Type de page. Les valeurs possibles sont : page, internal_link, external_link, separator |
page_parent_id | integer | Identifiant de la page parente |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
slugFacultatif | string | Nom optimisé |
has_restrictionsFacultatif | boolean | En accès restreint |
restrictionsFacultatif | List | Accès extranet |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
target_typeFacultatif | string | Type de catégorie du lien interne |
target_pageFacultatif | string | Type de page de la cible |
target_keyFacultatif | string | Identifiant de la page cible |
target_nameFacultatif | string | Intitulé de la page cible |
link_attributsFacultatif | string | Attributs du lien interne |
link_xtraFacultatif | string | Extra du lien interne |
link_descriptionFacultatif | string | Description du lien interne |
link_imageFacultatif | object | Image du lien interne |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
urlFacultatif | string | Url du lien externe |
url_targetFacultatif | string | Cible du lien externe |
api_key | string | Clé API du dossier |
Modifie un menu PUT
/v1/sites/{code_site}/cms/menus/{menu_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
menu_id | Obligatoire | integer | Identifiant du menu |
name | Obligatoire | string | Intitulé du menu |
Supprime un menu DELETE
/v1/sites/{code_site}/cms/menus/{menu_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
menu_id | Obligatoire | integer | Identifiant du menu |
Pages
Détail de la page d'accueil GET
/v1/sites/{code_site}/cms/home.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||
|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||||
Format de sortie :
data:{
"page_id": "integer",
"name": "string",
"is_visible": "boolean",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List"
}| Nom | Type | Description |
|---|---|---|
page_id | integer | Identifiant de la page |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
Modifie la page d'accueil PUT
/v1/sites/{code_site}/cms/home.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
name | string | Intitulé de la page | |
is_visible | boolean | Affichage de la page dans le menu | |
meta_title | string | Balise meta title de la page | |
meta_image | integer | Balise meta image | |
meta_description | string | Balise meta description de la page | |
meta_keywords | string | Balise meta keywords de la page | |
js_head | string | Code avant la balise </head> de la page | |
js_body | string | Code avant la balise </body> de la page | |
layout_id | integer | Identifiant de la mise en page de la page | |
Format de sortie :
data:{
"page_id": "integer",
"name": "string",
"is_visible": "boolean",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List"
}| Nom | Type | Description |
|---|---|---|
page_id | integer | Identifiant de la page |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
Ajoute une page POST
/v1/sites/{code_site}/cms/pages.json
Crée une nouvelle page
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||||||
page_type | string | Type de page parmis les valeurs suivantes :
Les valeurs attendues sont : page, internal_link, external_link, separator | |||||||||
name | string | Intitulé de la page | |||||||||
menu_id | integer | Identifiant du menu de rattachement | |||||||||
page_parent_id | integer | Identifiant de la page parente | |||||||||
is_visible | boolean | Affichage de la page dans le menu | |||||||||
target_type | string | Type de la cible pour les liens internes | |||||||||
target_page | string | Page cible pour les liens internes | |||||||||
target_key | string | Identifiant de la cible pour les liens internes | |||||||||
url | string | Adresse de redirection pour les liens externes | |||||||||
url_target | string | Cible de l'adresse de redirection pour les liens externes parmis les valeurs suivantes :
Les valeurs attendues sont : _self, _blank | |||||||||
slug | string | Nom optimisé de la page | |||||||||
meta_title | string | Balise meta title de la page | |||||||||
meta_image | integer | Balise meta image | |||||||||
meta_description | string | Balise meta description de la page | |||||||||
meta_keywords | string | Balise meta keywords de la page | |||||||||
js_head | string | Code avant la balise </head> de la page | |||||||||
js_body | string | Code avant la balise </body> de la page | |||||||||
layout_id | integer | Identifiant de la mise en page de la page | |||||||||
Format de sortie :
data:[]| Nom | Type | Description |
|---|
Supprime un lot de pages DELETE
/v1/sites/{code_site}/cms/pages.json
Permet de regrouper la suppression de jusqu'à 100 pages en un seul appel à l'API.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
pages | array | Identifiants de pages (max:100) | |
Copie une page POST
/v1/sites/{code_site}/cms/pages/{page_id}.json
Crée une copie d'une page existante
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page à copier |
name | string | Intitulé de la page | |
Format de sortie :
data:[]| Nom | Type | Description |
|---|
Modifie une page PUT
/v1/sites/{code_site}/cms/pages/{page_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||||||
page_id | Obligatoire | integer | Identifiant de la page | ||||||||
name | string | Intitulé de la page | |||||||||
menu_id | integer | Identifiant du menu de rattachement | |||||||||
page_parent_id | integer | Identifiant de la page parente | |||||||||
after_id | integer | Identifiant de la page d'insertion | |||||||||
before_id | integer | Identifiant de la page d'insertion | |||||||||
is_visible | boolean | Affichage de la page dans le menu | |||||||||
target_type | string | Type de la cible pour les liens internes | |||||||||
target_page | string | Page cible pour les liens internes | |||||||||
target_key | string | Identifiant de la cible pour les liens internes | |||||||||
link_attributs | string | Attributs du lien interne | |||||||||
link_xtra | string | Extra du lien interne | |||||||||
link_description | string | Description du lien interne | |||||||||
link_image | string | Image du lien interne | |||||||||
url | string | Adresse de redirection pour les liens externes | |||||||||
url_target | string | Cible de l'adresse de redirection pour les liens externes parmis les valeurs suivantes :
Les valeurs attendues sont : _self, _blank | |||||||||
slug | string | Nom optimisé de la page | |||||||||
meta_title | string | Balise meta title de la page | |||||||||
meta_image | integer | Balise meta image | |||||||||
meta_description | string | Balise meta description de la page | |||||||||
meta_keywords | string | Balise meta keywords de la page | |||||||||
js_head | string | Code avant la balise </head> de la page | |||||||||
js_body | string | Code avant la balise </body> de la page | |||||||||
layout_id | integer | Identifiant de la mise en page de la page | |||||||||
page_type | string | Type de page parmis les valeurs suivantes :
Les valeurs attendues sont : page, internal_link, external_link, separator | |||||||||
Format de sortie :
data:{
"page_id": "integer",
"menu_id": "integer",
"page_type": "string",
"page_parent_id": "integer",
"name": "string",
"is_visible": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"slug": "string",
"has_restrictions": "boolean",
"restrictions": "List",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List",
"target_type": "string",
"target_page": "string",
"target_key": "string",
"target_name": "string",
"link_attributs": "string",
"link_xtra": "string",
"link_description": "string",
"link_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"url": "string",
"url_target": "string"
}| Nom | Type | Description |
|---|---|---|
page_id | integer | Identifiant de la page |
menu_id | integer | Identifiant du menu de la page |
page_type | string | Type de page. Les valeurs possibles sont : page, internal_link, external_link, separator |
page_parent_id | integer | Identifiant de la page parente |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
slugFacultatif | string | Nom optimisé |
has_restrictionsFacultatif | boolean | En accès restreint |
restrictionsFacultatif | List | Accès extranet |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
target_typeFacultatif | string | Type de catégorie du lien interne |
target_pageFacultatif | string | Type de page de la cible |
target_keyFacultatif | string | Identifiant de la page cible |
target_nameFacultatif | string | Intitulé de la page cible |
link_attributsFacultatif | string | Attributs du lien interne |
link_xtraFacultatif | string | Extra du lien interne |
link_descriptionFacultatif | string | Description du lien interne |
link_imageFacultatif | object | Image du lien interne |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
urlFacultatif | string | Url du lien externe |
url_targetFacultatif | string | Cible du lien externe |
Supprime une page DELETE
/v1/sites/{code_site}/cms/pages/{page_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
Détail d'une page GET
/v1/sites/{code_site}/cms/pages/{page_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||
|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
page_id | Obligatoire | integer | Identifiant de la page | ||||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||||
Format de sortie :
data:{
"page_id": "integer",
"menu_id": "integer",
"page_type": "string",
"page_parent_id": "integer",
"name": "string",
"is_visible": "boolean",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"is_home": "boolean",
"slug": "string",
"has_restrictions": "boolean",
"restrictions": "List",
"meta_title": "string",
"meta_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"meta_description": "string",
"meta_keywords": "string",
"js_head": "string",
"js_body": "string",
"layout_id": "integer",
"zones": "List",
"target_type": "string",
"target_page": "string",
"target_key": "string",
"target_name": "string",
"link_attributs": "string",
"link_xtra": "string",
"link_description": "string",
"link_image": {
"id": "integer",
"ext": "string",
"url": "string",
"url_g_miniature": "string",
"url_g_vignette": "string",
"url_miniature": "string",
"url_vignette": "string",
"url_public": "string"
},
"url": "string",
"url_target": "string"
}| Nom | Type | Description |
|---|---|---|
page_id | integer | Identifiant de la page |
menu_id | integer | Identifiant du menu de la page |
page_type | string | Type de page. Les valeurs possibles sont : page, internal_link, external_link, separator |
page_parent_id | integer | Identifiant de la page parente |
name | string | Intitulé de la page |
is_visible | boolean | Page visible dans le menu |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
is_homeFacultatif | boolean | Page d'accueil |
slugFacultatif | string | Nom optimisé |
has_restrictionsFacultatif | boolean | En accès restreint |
restrictionsFacultatif | List | Accès extranet |
meta_titleFacultatif | string | Balise meta title |
meta_imageFacultatif | object | Balise meta image |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
meta_descriptionFacultatif | string | Balise meta description |
meta_keywordsFacultatif | string | Balise meta keywords |
js_headFacultatif | string | Code avant la balise </head> |
js_bodyFacultatif | string | Code avant la balise </body> |
layout_idFacultatif | integer | Identifiant de la mise en page |
zonesFacultatif | List | Zones de contenus |
target_typeFacultatif | string | Type de catégorie du lien interne |
target_pageFacultatif | string | Type de page de la cible |
target_keyFacultatif | string | Identifiant de la page cible |
target_nameFacultatif | string | Intitulé de la page cible |
link_attributsFacultatif | string | Attributs du lien interne |
link_xtraFacultatif | string | Extra du lien interne |
link_descriptionFacultatif | string | Description du lien interne |
link_imageFacultatif | object | Image du lien interne |
idFacultatif | integer | Identifiant du media |
ext | string | Extension du media |
url | string | Url du media |
url_g_miniatureFacultatif | string | Url de la grande miniature |
url_g_vignetteFacultatif | string | Url de la grande vignette |
url_miniatureFacultatif | string | Url de la miniature |
url_vignetteFacultatif | string | Url de la vignette |
url_publicFacultatif | string | Url front-office du média |
urlFacultatif | string | Url du lien externe |
url_targetFacultatif | string | Cible du lien externe |
Liste les droits extranet d'une page GET
/v1/sites/{code_site}/cms/pages/{page_id}/restrictions.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
Format de sortie :
data:[
{
"type": "string",
"customer_id": "integer",
"customer_firstname": "string",
"customer_lastname": "string",
"group_id": "integer",
"group_name": "string",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer"
}
]| Nom | Type | Description |
|---|---|---|
type | string | Type de restriction |
customer_idFacultatif | integer | Identifiant du client |
customer_firstnameFacultatif | string | Prénom du client |
customer_lastnameFacultatif | string | Nom du client |
group_idFacultatif | integer | Identifiant du groupe extranet |
group_nameFacultatif | string | Nom du groupe extranet |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
Définis les droits extranet à une page PUT
/v1/sites/{code_site}/cms/pages/{page_id}/restrictions.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
customer_id | array | Liste d'identifiants des utilisateurs | |
group_id | array | Liste d'identifiants des groupes | |
Supprime les droits extranet d'une page DELETE
/v1/sites/{code_site}/cms/pages/{page_id}/restrictions.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
customer_id | array | Liste d'identifiants des utilisateurs | |
group_id | array | Liste d'identifiants des groupes | |
Ajoute un droit extranet à une page POST
/v1/sites/{code_site}/cms/pages/{page_id}/restrictions.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
customer_id | integer | Identifiant d'un utilisateur | |
group_id | integer | Identifiant d'un groupe | |
Symboles
Liste les symboles GET
/v1/sites/{code_site}/cms/symbols.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:[
{
"symbol_id": "integer",
"model": "string",
"slug": "string",
"params": "List",
"usage": "integer",
"zones": [
{
"id": "string",
"name": "string"
}
],
"layout_id": "integer"
}
]| Nom | Type | Description |
|---|---|---|
symbol_id | integer | Identifiant du symbole |
model | string | Modèle |
slug | string | Nom optimisé |
paramsFacultatif | List | Paramètres |
usage | integer | Nombre d'utilisations dans des pages |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
layout_idFacultatif | integer | Mise en page |
Crée un symbole POST
/v1/sites/{code_site}/cms/symbols.json
Permet la création d'un symbole, jusqu'à un total de 35 symboles différents. Nécessite la gestion des composants.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
slug | string | Nom optimisé | |
model | string | Identifiant du modèle | |
title | string | Intitulé | |
Format de sortie :
data:{
"symbol_id": "integer",
"model": "string",
"slug": "string",
"params": "List",
"usage": "integer",
"zones": [
{
"id": "string",
"name": "string"
}
],
"layout_id": "integer"
}| Nom | Type | Description |
|---|---|---|
symbol_id | integer | Identifiant du symbole |
model | string | Modèle |
slug | string | Nom optimisé |
paramsFacultatif | List | Paramètres |
usage | integer | Nombre d'utilisations dans des pages |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
layout_idFacultatif | integer | Mise en page |
Modèles de symboles GET
/v1/sites/{code_site}/cms/symbols/models.json
Liste des modèles pour les symboles (nécessite les composants)
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||||
filter | string | Filtre par identifiant de type | |||||||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||||||
Format de sortie :
data:[
{
"id": "string",
"name": "string",
"fields": [
{
"field": "string",
"type": "string",
"name": "string",
"default": "string",
"help": "string",
"options": [
{
"label": "string",
"value": "string"
}
]
}
],
"structure": "string",
"zones": [
{
"id": "string",
"name": "string"
}
]
}
]| Nom | Type | Description |
|---|---|---|
id | string | Identififant |
name | string | Nom |
fieldsFacultatif | object | Champs |
field | string | Nom du champ |
type | string | Type de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, file |
name | string | Intitulé du champ |
defaultFacultatif | string | Valeur par défaut |
helpFacultatif | string | Aide à la saisie |
optionsFacultatif | object | Options pour un champ de type select |
label | string | Intitulé de l'option |
value | string | Valeur de l'option |
structureFacultatif | string | Structure |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
Copie un symbole POST
/v1/sites/{code_site}/cms/symbols/{symbol_id}.json
Copie d'un symbole existant.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | string | Identifiant du symbole à dupliquer |
slug | string | Nom optimisé | |
model | string | Identifiant du modèle | |
title | string | Intitulé | |
Format de sortie :
data:{
"symbol_id": "integer",
"model": "string",
"slug": "string",
"params": "List",
"usage": "integer",
"zones": [
{
"id": "string",
"name": "string"
}
],
"layout_id": "integer"
}| Nom | Type | Description |
|---|---|---|
symbol_id | integer | Identifiant du symbole |
model | string | Modèle |
slug | string | Nom optimisé |
paramsFacultatif | List | Paramètres |
usage | integer | Nombre d'utilisations dans des pages |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
layout_idFacultatif | integer | Mise en page |
Détail d'un symbole GET
/v1/sites/{code_site}/cms/symbols/{symbol_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
symbol_id | Obligatoire | string | Identifiant du symbole | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:{
"symbol_id": "integer",
"model": "string",
"slug": "string",
"params": "List",
"usage": "integer",
"zones": [
{
"id": "string",
"name": "string"
}
],
"layout_id": "integer"
}| Nom | Type | Description |
|---|---|---|
symbol_id | integer | Identifiant du symbole |
model | string | Modèle |
slug | string | Nom optimisé |
paramsFacultatif | List | Paramètres |
usage | integer | Nombre d'utilisations dans des pages |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
layout_idFacultatif | integer | Mise en page |
Modifie un symbole PUT
/v1/sites/{code_site}/cms/symbols/{symbol_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | integer | Identifiant du symbole |
slug | string | Nom optimisé | |
model | string | Modèle | |
params | array | Champs spécifiques au type de contenu | |
Format de sortie :
data:{
"symbol_id": "integer",
"model": "string",
"slug": "string",
"params": "List",
"usage": "integer",
"zones": [
{
"id": "string",
"name": "string"
}
],
"layout_id": "integer"
}| Nom | Type | Description |
|---|---|---|
symbol_id | integer | Identifiant du symbole |
model | string | Modèle |
slug | string | Nom optimisé |
paramsFacultatif | List | Paramètres |
usage | integer | Nombre d'utilisations dans des pages |
zonesFacultatif | object | Zones de contenus |
id | string | Identifiant de la zone |
name | string | Intitulé de la zone |
layout_idFacultatif | integer | Mise en page |
Supprime un symbole DELETE
/v1/sites/{code_site}/cms/symbols/{symbol_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | integer | Identifiant du symbole |
Contenus
Supprime un lot d'éléments DELETE
/v1/sites/{code_site}/cms/collection.json
Permet de regrouper la suppression de jusqu'à 100 éléments de collections en un seul appel à l'API.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
items | array | Identifiants des éléments (max:100) | |
Détail d'un élément GET
/v1/sites/{code_site}/cms/collection/{item_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
item_id | Obligatoire | integer | Identifiant de l'élement |
Format de sortie :
data:{
"item_id": "integer",
"content_id": "integer",
"is_visible": "boolean",
"position": "integer",
"fields": "List"
}| Nom | Type | Description |
|---|---|---|
item_id | integer | Identifiant de l'élément |
content_id | integer | Identifiant du contenu |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
fieldsFacultatif | List | Paramètres |
Modifie un élément PUT
/v1/sites/{code_site}/cms/collection/{item_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
item_id | Obligatoire | integer | Identifiant de l'élément |
is_visible | boolean | Affichage de l'élément | |
fields | array | Champs | |
Format de sortie :
data:{
"item_id": "integer",
"content_id": "integer",
"is_visible": "boolean",
"position": "integer",
"fields": "List"
}| Nom | Type | Description |
|---|---|---|
item_id | integer | Identifiant de l'élément |
content_id | integer | Identifiant du contenu |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
fieldsFacultatif | List | Paramètres |
Supprime un élément DELETE
/v1/sites/{code_site}/cms/collection/{item_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
item_id | Obligatoire | integer | Identifiant de l'élément |
Types de composants GET
/v1/sites/{code_site}/cms/components.json
Retoune la liste de tous les types de composants disponibles (nécessite les composants)
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||
|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
filter | string | Filtre par identifiant de type | |||||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||||
Format de sortie :
data:[
{
"type": "string",
"name": "string",
"position": "integer",
"fields": [
{
"field": "string",
"type": "string",
"name": "string",
"default": "string",
"help": "string",
"options": [
{
"label": "string",
"value": "string"
}
]
}
],
"collection": [
{
"field": "string",
"type": "string",
"name": "string",
"default": "string",
"help": "string",
"options": [
{
"label": "string",
"value": "string"
}
]
}
],
"has_collection": "boolean"
}
]| Nom | Type | Description |
|---|---|---|
type | string | Identifiant du type de schéma |
name | string | Intitulé du type de schéma |
position | integer | Ordre du type de schéma |
fieldsFacultatif | object | Structure des champs |
field | string | Nom du champ |
type | string | Type de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, file |
name | string | Intitulé du champ |
defaultFacultatif | string | Valeur par défaut |
helpFacultatif | string | Aide à la saisie |
optionsFacultatif | object | Options pour un champ de type select |
label | string | Intitulé de l'option |
value | string | Valeur de l'option |
collectionFacultatif | object | Structure de la collection |
field | string | Nom du champ |
type | string | Type de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, file |
name | string | Intitulé du champ |
defaultFacultatif | string | Valeur par défaut |
helpFacultatif | string | Aide à la saisie |
optionsFacultatif | object | Options pour un champ de type select |
label | string | Intitulé de l'option |
value | string | Valeur de l'option |
has_collection | boolean | Le composant gère une collection d'éléments |
Supprime un lot de contenus DELETE
/v1/sites/{code_site}/cms/contents.json
Permet de regrouper la suppression de jusqu'à 100 contenus en un seul appel à l'API.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
contents | array | Identifiants de contenus (max:100) | |
Publie un composant POST
/v1/sites/{code_site}/cms/contents/component.json
Crée un composant dans une page ou un symbole (nécessite la gestion des composants).
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
container_type | Obligatoire | string | Type de conteneur Les valeurs attendues sont : page, symbol |
container_id | Obligatoire | integer | Identifiant du conteneur |
zone | string | Zone | |
is_visible | boolean | Visibilité | |
type | Obligatoire | string | Type de composant |
fields | array | Champs spécifiques du composant | |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Publie un billet POST
/v1/sites/{code_site}/cms/contents/post.json
Crée un billet dans une page ou un symbole. Le paramètre zone est ignoré sans gestion de composants.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
container_type | Obligatoire | string | Type de conteneur Les valeurs attendues sont : page, symbol |
container_id | Obligatoire | integer | Identifiant du conteneur |
zone | string | Zone (nécessite la gestion des composants) | |
is_visible | boolean | Visibilité | |
type | Obligatoire | string | Type de billet |
title | string | Titre du billet | |
subtitle | string | Sous titre du billet | |
text1 | string | Champ texte1 billet | |
text2 | string | Champ texte2 billet | |
text3 | string | Champ texte3 billet | |
text4 | string | Champ texte4 billet | |
text5 | string | Champ texte5 billet | |
text6 | string | Champ texte6 billet | |
text7 | string | Champ texte7 billet | |
text8 | string | Champ texte8 billet | |
text9 | string | Champ texte9 billet | |
text10 | string | Champ texte10 billet | |
text11 | string | Champ texte11 billet | |
text12 | string | Champ texte12 billet | |
text13 | string | Champ texte13 billet | |
text14 | string | Champ texte14 billet | |
text15 | string | Champ texte15 billet | |
group | string | Nom du groupe du billet | |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Publie un symbole POST
/v1/sites/{code_site}/cms/contents/symbol.json
Ajoute un symbole existant dans une page (nécessite la gestion des composants).
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
container_type | Obligatoire | string | Type de conteneur Les valeurs attendues sont : page |
container_id | Obligatoire | integer | Identifiant du conteneur |
zone | string | Zone | |
is_visible | boolean | Visibilité | |
symbol_id | Obligatoire | string | Identifiant du symbole |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Détail d'un contenu GET
/v1/sites/{code_site}/cms/contents/{content_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
content_id | Obligatoire | integer | Identifiant du contenu | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Modifie un contenu PUT
/v1/sites/{code_site}/cms/contents/{content_id}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
zone | string | Zone (nécessite les composants) | |
is_visible | boolean | Visibilité | |
container_id | integer | Identifiant du conteneur cible pour le déplacement. Uniquement pour les contenus de pages. | |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Copie un contenu POST
/v1/sites/{code_site}/cms/contents/{content_id}.json
Copie un contenu existant.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
Supprime un contenu DELETE
/v1/sites/{code_site}/cms/contents/{content_id}.json
Supprime un contenu. Supprime également la collection des composants.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
Contenu de la collection GET
/v1/sites/{code_site}/cms/contents/{content_id}/collection.json
Retourne les éléments d'une collection pour un contenu de type composant uniquement.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
content_id | Obligatoire | integer | Identifiant du contenu | ||
limit | integer | Nombre d'éléments par page (valeur par défaut : 20, maximum : 20) | |||
page | integer | Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut) | |||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:[
{
"item_id": "integer",
"content_id": "integer",
"is_visible": "boolean",
"position": "integer",
"fields": "List"
}
]| Nom | Type | Description |
|---|---|---|
item_id | integer | Identifiant de l'élément |
content_id | integer | Identifiant du contenu |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
fieldsFacultatif | List | Paramètres |
Vide une collection DELETE
/v1/sites/{code_site}/cms/contents/{content_id}/collection.json
Supprime tous les éléments d'une collection.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
Réordone une collection PUT
/v1/sites/{code_site}/cms/contents/{content_id}/collection.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
order | array | Liste des identifiants des éléments | |
Ajoute un élément POST
/v1/sites/{code_site}/cms/contents/{content_id}/collection.json
Ajoute un élément dans une collection (nécessite les composants).
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
is_visible | boolean | Affichage de l'élément | |
fields | array | Champs | |
Format de sortie :
data:{
"item_id": "integer",
"content_id": "integer",
"is_visible": "boolean",
"position": "integer",
"fields": "List"
}| Nom | Type | Description |
|---|---|---|
item_id | integer | Identifiant de l'élément |
content_id | integer | Identifiant du contenu |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
fieldsFacultatif | List | Paramètres |
Modifie un composant PUT
/v1/sites/{code_site}/cms/contents/{content_id}/component.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
fields | array | Champs du composant | |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Modifie un billet PUT
/v1/sites/{code_site}/cms/contents/{content_id}/post.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
content_id | Obligatoire | integer | Identifiant du contenu |
type | string | Type de billet | |
title | string | Titre du billet | |
subtitle | string | Sous titre du billet | |
text1 | string | Champ texte1 billet | |
text2 | string | Champ texte2 billet | |
text3 | string | Champ texte3 billet | |
text4 | string | Champ texte4 billet | |
text5 | string | Champ texte5 billet | |
text6 | string | Champ texte6 billet | |
text7 | string | Champ texte7 billet | |
text8 | string | Champ texte8 billet | |
text9 | string | Champ texte9 billet | |
text10 | string | Champ texte10 billet | |
text11 | string | Champ texte11 billet | |
text12 | string | Champ texte12 billet | |
text13 | string | Champ texte13 billet | |
text14 | string | Champ texte14 billet | |
text15 | string | Champ texte15 billet | |
group | string | Nom du groupe du billet | |
Format de sortie :
data:{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Liste le contenu d'une page GET
/v1/sites/{code_site}/cms/pages/{page_id}/contents.json
Liste les billets, composants et symboles d'une page.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
zone | string | Filtre les contenus de la zone désignée (nécessite les composants) | |
content | string | Filtre du type de contenu : billets, composants ou symbole Les valeurs attendues sont : post, component, symbol | |
Format de sortie :
data:[
{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}
]| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Réordonne les contenus PUT
/v1/sites/{code_site}/cms/pages/{page_id}/contents.json
Réordonne les contenus d'une page à l'intérieur d'une zone. Pour les sites ne disposant pas des composants, le paramètre zone est ignoré.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
zone | string | Zone (nécessite les composants) | |
order | array | Liste des identifiants des contenus | |
Vide une page DELETE
/v1/sites/{code_site}/cms/pages/{page_id}/contents.json
Supprime tous les contenus de la page indiquée.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
Contenu d'un symbole GET
/v1/sites/{code_site}/cms/symbols/{symbol_id}/contents.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | string | Identifiant du symbole |
zone | string | Filtre les contenus de la zone désignée | |
content | string | Filtre du type de contenu : billets ou composants Les valeurs attendues sont : post, component | |
limit | integer | Nombre d'éléments par page (valeur par défaut : 20, maximum : 20) | |
page | integer | Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut) | |
Format de sortie :
data:[
{
"content_id": "integer",
"zone": "string",
"content_title": "string",
"container_id": "integer",
"container_type": "string",
"content": "string",
"is_visible": "boolean",
"position": "integer",
"post": {
"title": "string",
"subtitle": "string",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string",
"group": "string",
"type": "string",
"type_name": "string",
"type_position": "integer"
},
"symbol": {
"symbol_id": "integer",
"model": "string",
"model_name": "string"
},
"component": {
"type": "string",
"type_name": "string",
"type_position": "integer",
"fields": "List",
"count": "integer"
}
}
]| Nom | Type | Description |
|---|---|---|
content_id | integer | Identifiant du contenu |
zone | string | Zone de rattachement du contenu |
content_title | string | Rappel du titre du contenu |
container_id | integer | Identifiant du contenaire |
container_type | string | Type de contenaire. Les valeurs possibles sont : page, symbol |
content | string | Type de contenu. Les valeurs possibles sont : post, component, symbol |
is_visible | boolean | Contenu visible |
position | integer | Position dans la liste |
postFacultatif | object | Données du billet |
title | string | Titre du billet |
subtitleFacultatif | string | Sous titre |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
group | string | Groupe |
type | string | Type du billet |
type_name | string | Intiutlé du type |
type_position | integer | Ordre de tri du type |
symbolFacultatif | object | Données du symbole |
symbol_id | integer | Identifiant du symbole |
model | string | Modèle du symbole |
model_name | string | Intitulé du modèle |
componentFacultatif | object | Données du composant |
type | string | Type du composant |
type_name | string | Intitulé du type |
type_position | integer | Ordre de tri du type |
fieldsFacultatif | List | Paramètres |
count | integer | Nombre d'éléments dans la collection |
Réordonne les contenus PUT
/v1/sites/{code_site}/cms/symbols/{symbol_id}/contents.json
Réordonne les contenus d'un symbole
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | string | Identifiant du symbole |
zone | string | Zone | |
order | array | Liste des identifiants des contenus | |
Supprime le contenu d'un symbole DELETE
/v1/sites/{code_site}/cms/symbols/{symbol_id}/contents.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
symbol_id | Obligatoire | string | Identifiant du symbole |
Billets (déprécié)
Liste les billets d'une page GET
/v1/sites/{code_site}/cms/pages/{page_id}/posts.json
Liste tous les billets d'une page quel que soit leur zone d'assignation.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
page_id | Obligatoire | integer | Identifiant de la page | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:[
{
"post_id": "integer",
"content_id": "integer",
"page_id": "integer",
"page_name": "string",
"is_home": "boolean",
"type": "string",
"type_name": "string",
"type_pos": "integer",
"title": "string",
"subtitle": "string",
"group": "string",
"is_visible": "boolean",
"position": "integer",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string"
}
]| Nom | Type | Description |
|---|---|---|
post_id | integer | Identifiant du billet |
content_id | integer | Identifiant du contenu |
page_id | integer | Identifiant de la page du billet |
page_name | string | Intitulé de la page |
is_homeFacultatif | boolean | Page d'accueil |
type | string | Code du type de billet |
type_nameFacultatif | string | Nom du type de billet |
type_posFacultatif | integer | Ordre de tri du type de billet |
title | string | Titre |
subtitle | string | Sous titre |
group | string | Nom du groupe |
is_visible | boolean | Billet visible |
position | integer | Position dans la liste |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
Vide une page DELETE
/v1/sites/{code_site}/cms/pages/{page_id}/posts.json
Supprime tous les billets de page indiquée.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
Réordonne les billets d'une page PUT
/v1/sites/{code_site}/cms/pages/{page_id}/posts.json
Réordonne les billets d'une page. Il est préférable d'utiliser le endpoint "Réordonne les contenus" une fois la gestion de composant activé sur le site.
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
order | Obligatoire | array | Liste des identifiants des billets |
Liste les billets GET
/v1/sites/{code_site}/cms/posts.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
group | string | Nom du groupe de billet | |||
term | string | Recherche par libellé | |||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:[
{
"post_id": "integer",
"content_id": "integer",
"page_id": "integer",
"page_name": "string",
"is_home": "boolean",
"type": "string",
"type_name": "string",
"type_pos": "integer",
"title": "string",
"subtitle": "string",
"group": "string",
"is_visible": "boolean",
"position": "integer",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string"
}
]| Nom | Type | Description |
|---|---|---|
post_id | integer | Identifiant du billet |
content_id | integer | Identifiant du contenu |
page_id | integer | Identifiant de la page du billet |
page_name | string | Intitulé de la page |
is_homeFacultatif | boolean | Page d'accueil |
type | string | Code du type de billet |
type_nameFacultatif | string | Nom du type de billet |
type_posFacultatif | integer | Ordre de tri du type de billet |
title | string | Titre |
subtitle | string | Sous titre |
group | string | Nom du groupe |
is_visible | boolean | Billet visible |
position | integer | Position dans la liste |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
Ajoute un billet dans une page POST
/v1/sites/{code_site}/cms/posts.json
Crée un billet et l'ajoute à la fin d'une page. Il est préférable d'utiliser le endpoint "Publie un billet".
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
page_id | Obligatoire | integer | Identifiant de la page |
type | Obligatoire | string | Type de billet |
is_visible | boolean | Affichage du billet | |
group | string | Nom du groupe du billet | |
title | string | Titre du billet | |
subtitle | string | Sous titre du billet | |
text1 | string | Champ texte1 billet | |
text2 | string | Champ texte2 billet | |
text3 | string | Champ texte3 billet | |
text4 | string | Champ texte4 billet | |
text5 | string | Champ texte5 billet | |
text6 | string | Champ texte6 billet | |
text7 | string | Champ texte7 billet | |
text8 | string | Champ texte8 billet | |
text9 | string | Champ texte9 billet | |
text10 | string | Champ texte10 billet | |
text11 | string | Champ texte11 billet | |
text12 | string | Champ texte12 billet | |
text13 | string | Champ texte13 billet | |
text14 | string | Champ texte14 billet | |
text15 | string | Champ texte15 billet | |
Format de sortie :
data:[]| Nom | Type | Description |
|---|
Supprime un lot de billets DELETE
/v1/sites/{code_site}/cms/posts.json
Permet de regrouper la suppression de jusqu'à 100 billets du site web en un seul appel à l'API. Il est préférable d'utiliser le endpoint "Supprime un lot de contenus"
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
posts | array | Identifiants de billets (max:100) | |
Détail d'un billet d'une page GET
/v1/sites/{code_site}/cms/posts/{post_id}.json
Retourne les informations d'un billet d'une page. Il est préférable d'utiliser le endpoint "Détail d'un contenu".
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||||
|---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
post_id | Obligatoire | integer | Identifiant du billet | ||||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||||
Format de sortie :
data:{
"post_id": "integer",
"content_id": "integer",
"page_id": "integer",
"page_name": "string",
"is_home": "boolean",
"type": "string",
"type_name": "string",
"type_pos": "integer",
"title": "string",
"subtitle": "string",
"group": "string",
"is_visible": "boolean",
"position": "integer",
"creation_date": "string",
"creation_date_f": "string",
"creation_date_timestamp": "integer",
"modification_date": "string",
"modification_date_f": "string",
"modification_date_timestamp": "integer",
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string",
"text5": "string",
"text6": "string",
"text7": "string",
"text8": "string",
"text9": "string",
"text10": "string",
"text11": "string",
"text12": "string",
"text13": "string",
"text14": "string",
"text15": "string"
}| Nom | Type | Description |
|---|---|---|
post_id | integer | Identifiant du billet |
content_id | integer | Identifiant du contenu |
page_id | integer | Identifiant de la page du billet |
page_name | string | Intitulé de la page |
is_homeFacultatif | boolean | Page d'accueil |
type | string | Code du type de billet |
type_nameFacultatif | string | Nom du type de billet |
type_posFacultatif | integer | Ordre de tri du type de billet |
title | string | Titre |
subtitle | string | Sous titre |
group | string | Nom du groupe |
is_visible | boolean | Billet visible |
position | integer | Position dans la liste |
creation_date | string | Date de création |
creation_date_f | string | Date de création formatée |
creation_date_timestamp | integer | Timestamp de la date de création |
modification_dateFacultatif | string | Date de dernière modification |
modification_date_fFacultatif | string | Date de dernière modification formatée |
modification_date_timestampFacultatif | integer | Timestamp de la date de dernière modification |
text1Facultatif | string | Champ texte1 |
text2Facultatif | string | Champ texte2 |
text3Facultatif | string | Champ texte3 |
text4Facultatif | string | Champ texte4 |
text5Facultatif | string | Champ texte5 |
text6Facultatif | string | Champ texte6 |
text7Facultatif | string | Champ texte7 |
text8Facultatif | string | Champ texte8 |
text9Facultatif | string | Champ texte9 |
text10Facultatif | string | Champ texte10 |
text11Facultatif | string | Champ texte11 |
text12Facultatif | string | Champ texte12 |
text13Facultatif | string | Champ texte13 |
text14Facultatif | string | Champ texte14 |
text15Facultatif | string | Champ texte15 |
Modifie un billet PUT
/v1/sites/{code_site}/cms/posts/{post_id}.json
Il est préférable d'utiliser le endpoint "Modifie un billet"
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
post_id | Obligatoire | integer | Identifiant du billet |
page_id | integer | Identifiant de la page du billet | |
type | string | Type de billet | |
is_visible | boolean | Affichage du billet | |
group | string | Nom du groupe du billet | |
title | string | Titre du billet | |
subtitle | string | Sous titre du billet | |
text1 | string | Champ texte1 billet | |
text2 | string | Champ texte2 billet | |
text3 | string | Champ texte3 billet | |
text4 | string | Champ texte4 billet | |
text5 | string | Champ texte5 billet | |
text6 | string | Champ texte6 billet | |
text7 | string | Champ texte7 billet | |
text8 | string | Champ texte8 billet | |
text9 | string | Champ texte9 billet | |
text10 | string | Champ texte10 billet | |
text11 | string | Champ texte11 billet | |
text12 | string | Champ texte12 billet | |
text13 | string | Champ texte13 billet | |
text14 | string | Champ texte14 billet | |
text15 | string | Champ texte15 billet | |
Supprime un billet DELETE
/v1/sites/{code_site}/cms/posts/{post_id}.json
Il est préférable d'utiliser le endpoint "Supprime un contenu"
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
post_id | Obligatoire | integer | Identifiant du billet |
Liste les groupes de billet GET
/v1/sites/{code_site}/cms/posts_groups.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:[
{
"name": "string"
}
]| Nom | Type | Description |
|---|---|---|
name | string | Intitulé du groupe de billets |
Liste les types de billets GET
/v1/sites/{code_site}/cms/posts_types.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||
filter | string | Filtre par identifiant de type | |||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
Format de sortie :
data:[
{
"type": "string",
"name": "string",
"position": "integer",
"fields": [
{
"field": "string",
"type": "string",
"name": "string",
"help": "string",
"options": [
{
"label": "string",
"value": "string"
}
]
}
]
}
]| Nom | Type | Description |
|---|---|---|
type | string | Identifiant du type de schéma |
name | string | Intitulé du type de schéma |
position | integer | Ordre du type de schéma |
fieldsFacultatif | object | Structure des champs |
field | string | Nom du champ. Les valeurs possibles sont : title, subtitle, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15 |
type | string | Type de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, fichier |
name | string | Intitulé du champ |
helpFacultatif | string | Aide à la saisie |
optionsFacultatif | object | Options pour un champ de type select |
label | string | Intitulé de l'option |
value | string | Valeur de l'option |
Liens internes
Liste les catégories de liens internes GET
/v1/sites/{code_site}/cms/internal_links/targets.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:[
{
"type": "string",
"name": "string"
}
]| Nom | Type | Description |
|---|---|---|
type | string | Type de la catégorie |
name | string | Intitulé de la catégorie |
Liste les cibles des liens internes GET
/v1/sites/{code_site}/cms/internal_links/targets/{name}.json
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
code_site | Obligatoire | string | Code site |
name | Obligatoire | string | Nom de la catégorie |
Format de sortie :
data:[
{
"name": "string",
"depth": "integer",
"url": "string",
"target_type": "string",
"target_page": "string",
"target_key": "string",
"is_linkable": "boolean"
}
]| Nom | Type | Description |
|---|---|---|
name | string | Intitulé de la cible |
depth | integer | Profondeur de la cible |
url | string | Url de la cible |
target_type | string | Type de catégorie du lien interne |
target_page | string | Type de page de la cible |
target_key | string | Identifiant de la page cible |
is_linkable | boolean | Utilisable comme lien |