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 :

Nom		Type	Description
`key`	Obligatoire	string	Identifiant api du menu
`depth`		integer	Profondeur de recherche Les valeurs attendues sont : 1, 2, 3, 4

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "is_home": "boolean",
        "type": "string",
        "title": "string",
        "slug": "string",
        "url": "string",
        "depth": "integer",
        "link": {
            "thumb": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "url": "string",
                "url_miniature": "string",
                "url_vignette": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string"
            },
            "description": "string",
            "xtra": "string",
            "attributes": "string"
        }
    }
]

Nom	Type	Description
`is_home`	boolean	Identifie la page d'acceuil
`type`	string	Type de la page
`title`	string	Intitulé de la page
`slug`	string	Nom optimisé de la page
`url`	string	URL de la page
`depth`	integer	Profondeur de la page dans l'arborescence du menu
`link`Facultatif	object	Informations complémentaires du lien interne
`thumb`Facultatif	object	Image du lien
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`description`Facultatif	string	Description du lien
`xtra`Facultatif	string	Champ xtra du lien
`attributes`Facultatif	string	Attributs du lien

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 :

Nom		Type	Description
`slug`	Obligatoire	string	Nom optimisé de la page
`depth`		integer	Profondeur de recherche Les valeurs attendues sont : 1, 2, 3, 4

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "is_home": "boolean",
        "type": "string",
        "title": "string",
        "slug": "string",
        "url": "string",
        "depth": "integer",
        "link": {
            "thumb": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "url": "string",
                "url_miniature": "string",
                "url_vignette": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string"
            },
            "description": "string",
            "xtra": "string",
            "attributes": "string"
        }
    }
]

Nom	Type	Description
`is_home`	boolean	Identifie la page d'acceuil
`type`	string	Type de la page
`title`	string	Intitulé de la page
`slug`	string	Nom optimisé de la page
`url`	string	URL de la page
`depth`	integer	Profondeur de la page dans l'arborescence du menu
`link`Facultatif	object	Informations complémentaires du lien interne
`thumb`Facultatif	object	Image du lien
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`description`Facultatif	string	Description du lien
`xtra`Facultatif	string	Champ xtra du lien
`attributes`Facultatif	string	Attributs du lien

Récupére la page parente d'une page GET

`/api/v1/cms/pages/{slug}/parent.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`slug`	Obligatoire	string	Nom optimisé de la page

Format de sortie :

Schéma JSON
Modèle

data:{
    "is_home": "boolean",
    "type": "string",
    "title": "string",
    "slug": "string",
    "url": "string",
    "depth": "integer",
    "link": {
        "thumb": {
            "id": "integer",
            "title": "string",
            "description": "string",
            "url": "string",
            "url_miniature": "string",
            "url_vignette": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string"
        },
        "description": "string",
        "xtra": "string",
        "attributes": "string"
    }
}

Nom	Type	Description
`is_home`	boolean	Identifie la page d'acceuil
`type`	string	Type de la page
`title`	string	Intitulé de la page
`slug`	string	Nom optimisé de la page
`url`	string	URL de la page
`depth`	integer	Profondeur de la page dans l'arborescence du menu
`link`Facultatif	object	Informations complémentaires du lien interne
`thumb`Facultatif	object	Image du lien
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`description`Facultatif	string	Description du lien
`xtra`Facultatif	string	Champ xtra du lien
`attributes`Facultatif	string	Attributs du lien

Contenus

Liste les billets d'une page GET

`/api/v1/cms/pages/{slug}/posts.json`

Paramètres supportés par ce endpoint :

Nom Type Description

slug Obligatoire string Nom optimisé de la page

children flag Inclus les billets des pages enfants
Les valeurs attendues sont : 1

group_name string Restreins à un groupe de billet

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)

sort

array

Ordres de tri parmis les critères suivants :

title / -title	Tri selon le titre du billet
position / -position	Tri selon l'ordre des billets
rand	Tri aléatoire. Cet ordre de tri n'est pas compatible avec la pagination
crea / -crea	Date de création du billet

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

texts

Inclut les champs text1 à text15 de chaque billet

Format de sortie :

Schéma JSON
Modèle

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"
    }
]

Nom	Type	Description
`type`	string	Type du billet
`title`	string	Titre du billet
`subtitle`	string	Soustitre du billet
`group`	string	Groupe du billet
`page_title`	string	Titre de la page
`page_slug`	string	Nom optimisé de la page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ texte15

Liste les billets d'un groupe GET

`/api/v1/cms/posts.json`

Paramètres supportés par ce endpoint :

Nom Type Description

group_name Obligatoire string Nom du groupe

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)

sort

array

Ordres de tri parmis les critères suivants :

title / -title	Tri selon le titre du billet
position / -position	Tri selon l'ordre des billets
rand	Tri aléatoire. Cet ordre de tri n'est pas compatible avec la pagination
crea / -crea	Date de création du billet

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

texts

Inclut les champs text1 à text15 de chaque billet

Format de sortie :

Schéma JSON
Modèle

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"
    }
]

Nom	Type	Description
`type`	string	Type du billet
`title`	string	Titre du billet
`subtitle`	string	Soustitre du billet
`group`	string	Groupe du billet
`page_title`	string	Titre de la page
`page_slug`	string	Nom optimisé de la page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ 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 :

Nom		Type	Description
`media_id`	Obligatoire	integer	Identifiant numérique du média

Format de sortie :

Schéma JSON
Modèle

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"
    }
}

Nom	Type	Description
`id`	integer	Identifiant du media
`type`	string	Type de fichier
`name`	string	Nom
`description`	string	Description
`original_name`	string	Nom original du fichier au chargement du fichier
`modification_date`	string	Date de modification
`modification_date_f`	string	Date de modification formatée
`modification_date_timestamp`	integer	Timestamp de la date de modification
`mime`	string	Type mime
`weight`	integer	Poids du fichier en octets
`width`Facultatif	integer	Largeur en pixel pour les images
`height`Facultatif	integer	Hauteur en pixel pour les images
`url`	string	URL du média
`thumb`Facultatif	object	Miniatures
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL 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 :

Nom Type Description

key Obligatoire string Identifiant dossier

sort

array

Détermine l'ordre de tri parmis les critères suivants :

alpha	Nom du fichier (ordre par défaut)
-date	Date de modification

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 :

thumb

Inclut les liens des miniatures pour chaque image

Format de sortie :

Schéma JSON
Modèle

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"
        }
    }
]

Nom	Type	Description
`id`	integer	Identifiant du media
`type`	string	Type de fichier
`name`	string	Nom
`description`	string	Description
`original_name`	string	Nom original du fichier au chargement du fichier
`modification_date`	string	Date de modification
`modification_date_f`	string	Date de modification formatée
`modification_date_timestamp`	integer	Timestamp de la date de modification
`mime`	string	Type mime
`weight`	integer	Poids du fichier en octets
`width`Facultatif	integer	Largeur en pixel pour les images
`height`Facultatif	integer	Hauteur en pixel pour les images
`url`	string	URL du média
`thumb`Facultatif	object	Miniatures
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette