Site web

Arborescence

Liste l'arborescence d'un menu GET
/api/v1/cms/menus/{key}/pages.json

Liste l'arborescence d'un menu avec la profondeur choisie. L'identifiant api du menu est à récupérer dans la console d'administration ou l'API Developers

Paramètres supportés par ce endpoint :

NomTypeDescription
keyObligatoirestringIdentifiant api du menu
depthintegerProfondeur de recherche
Les valeurs attendues sont : 1, 2, 3, 4

Format de sortie :

data:[
    {
        "is_home": "boolean",
        "type": "string",
        "title": "string",
        "slug": "string",
        "url": "string",
        "depth": "integer"
    }
]
NomTypeDescription
is_homebooleanIdentifie la page d'acceuil
typestringType de la page
titlestringIntitulé de la page
slugstringNom optimisé de la page
urlstringURL de la page
depthintegerProfondeur de la page dans l'arborescence du menu
Liste les sous pages GET
/api/v1/cms/pages/{slug}/children.json

Liste les pages enfants d'une page. Le paramètre depth permet de choisir la profondeur de l'arborescence qui serra retournée.

Paramètres supportés par ce endpoint :

NomTypeDescription
slugObligatoirestringNom optimisé de la page
depthintegerProfondeur de recherche
Les valeurs attendues sont : 1, 2, 3, 4

Format de sortie :

data:[
    {
        "is_home": "boolean",
        "type": "string",
        "title": "string",
        "slug": "string",
        "url": "string",
        "depth": "integer"
    }
]
NomTypeDescription
is_homebooleanIdentifie la page d'acceuil
typestringType de la page
titlestringIntitulé de la page
slugstringNom optimisé de la page
urlstringURL de la page
depthintegerProfondeur de la page dans l'arborescence du menu
Récupére la page parente d'une page GET
/api/v1/cms/pages/{slug}/parent.json

Paramètres supportés par ce endpoint :

NomTypeDescription
slugObligatoirestringNom optimisé de la page

Format de sortie :

data:{
    "is_home": "boolean",
    "type": "string",
    "title": "string",
    "slug": "string",
    "url": "string",
    "depth": "integer"
}
NomTypeDescription
is_homebooleanIdentifie la page d'acceuil
typestringType de la page
titlestringIntitulé de la page
slugstringNom optimisé de la page
urlstringURL de la page
depthintegerProfondeur de la page dans l'arborescence du menu

Contenus

Liste les billets d'une page GET
/api/v1/cms/pages/{slug}/posts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
slugObligatoirestringNom optimisé de la page
childrenflagInclus les billets des pages enfants
Les valeurs attendues sont : 1
group_namestringRestreins à un groupe de billet
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
title / -titleTri selon le titre du billet
position / -positionTri selon l'ordre des billets
randTri aléatoire. Cet ordre de tri n'est pas compatible avec la pagination
crea / -creaDate de création du billet
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
textsInclut les champs text1 à text15 de chaque billet

Format de sortie :

data:[
    {
        "type": "string",
        "title": "string",
        "subtitle": "string",
        "group": "string",
        "page_title": "string",
        "page_slug": "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"
    }
]
NomTypeDescription
typestringType du billet
titlestringTitre du billet
subtitlestringSoustitre du billet
groupstringGroupe du billet
page_titlestringTitre de la page
page_slugstringNom optimisé de la page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15
Liste les billets d'un groupe GET
/api/v1/cms/posts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
group_nameObligatoirestringNom du groupe
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
title / -titleTri selon le titre du billet
position / -positionTri selon l'ordre des billets
randTri aléatoire. Cet ordre de tri n'est pas compatible avec la pagination
crea / -creaDate de création du billet
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
textsInclut les champs text1 à text15 de chaque billet

Format de sortie :

data:[
    {
        "type": "string",
        "title": "string",
        "subtitle": "string",
        "group": "string",
        "page_title": "string",
        "page_slug": "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"
    }
]
NomTypeDescription
typestringType du billet
titlestringTitre du billet
subtitlestringSoustitre du billet
groupstringGroupe du billet
page_titlestringTitre de la page
page_slugstringNom optimisé de la page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15

Médiathèque

Retourne les informations d'un média GET
/api/v1/media/files/{media_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
media_idObligatoireintegerIdentifiant numérique du média

Format de sortie :

data:{
    "id": "integer",
    "type": "string",
    "name": "string",
    "description": "string",
    "original_name": "string",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "mime": "string",
    "weight": "integer",
    "width": "integer",
    "height": "integer",
    "url": "string",
    "thumb": {
        "id": "integer",
        "title": "string",
        "description": "string",
        "url": "string",
        "url_miniature": "string",
        "url_vignette": "string",
        "url_g_miniature": "string",
        "url_g_vignette": "string"
    }
}
NomTypeDescription
idintegerIdentifiant du media
typestringType de fichier
namestringNom
descriptionstringDescription
original_namestringNom original du fichier au chargement du fichier
modification_datestringDate de modification
modification_date_fstringDate de modification formatée
modification_date_timestampintegerTimestamp de la date de modification
mimestringType mime
weightintegerPoids du fichier en octets
widthFacultatifintegerLargeur en pixel pour les images
heightFacultatifintegerHauteur en pixel pour les images
urlstringURL du média
thumbFacultatifobjectMiniatures
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
Retourne les médias d'un dossier GET
/api/v1/media/folders/{key}.json

Retourne les médias contenus dans un dossier. L'identifiant unique du dossier est disponible dans le backoffice.

Paramètres supportés par ce endpoint :

NomTypeDescription
keyObligatoirestringIdentifiant dossier
sortarrayDétermine l'ordre de tri parmis les critères suivants :
alphaNom du fichier (ordre par défaut)
-dateDate de modification
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
thumbInclut les liens des miniatures pour chaque image

Format de sortie :

data:[
    {
        "id": "integer",
        "type": "string",
        "name": "string",
        "description": "string",
        "original_name": "string",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "mime": "string",
        "weight": "integer",
        "width": "integer",
        "height": "integer",
        "url": "string",
        "thumb": {
            "id": "integer",
            "title": "string",
            "description": "string",
            "url": "string",
            "url_miniature": "string",
            "url_vignette": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string"
        }
    }
]
NomTypeDescription
idintegerIdentifiant du media
typestringType de fichier
namestringNom
descriptionstringDescription
original_namestringNom original du fichier au chargement du fichier
modification_datestringDate de modification
modification_date_fstringDate de modification formatée
modification_date_timestampintegerTimestamp de la date de modification
mimestringType mime
weightintegerPoids du fichier en octets
widthFacultatifintegerLargeur en pixel pour les images
heightFacultatifintegerHauteur en pixel pour les images
urlstringURL du média
thumbFacultatifobjectMiniatures
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette