Récupération d'une liste d'article de blog
GET/v1/blog/article/
Vous avez la possibilité de récupérer une liste d'article de blog.
Request
- application/json
Body
Information sur le filtre
Default value: 1
Possible values: [published_at, id]
Default value: published_at
Ordonner en fonction de la date de publication des articles de blogs
Possible values: [asc, desc]
Default value: asc
Orderner la la liste de façon croissante ou décroissante
Possible values: [1, 0]
Default value: 1
- null : Visible et non visible sur votre site
- 1 : L'article de blog est visible sur votre site
- 0 : L'article de blog n'est pas visible sur votre site
Indiquez la date format ISO 8601
Indiquez la date format ISO 8601
Responses
- 200
- 400
- 401
- 404
- 429
Information sur les articles
- application/json
- application/xml
- Schema
- Example (from schema)
Schema
Array [
- 1 : La page est référencée par les moteurs de recherche.
- 2 : Ne pas référencer la page et ne pas suivre les liens de la page
- 3 : Ne pas référencer la page
- 4 : Ne pas suivre les liens de la page
Array [
]
Array [
]
]
paginator
object
Information sur la page courante de votre liste
Information sur le nombre d'éléments affiché sur chaque page
Information sur le nombre total d'éléments qui correspond à votre demande
items
object[]
Possible values: <= 100 characters
Titre de votre article de blog
Possible values: <= 255 characters
Description courte de votre article de blog
Contenu texte de votre article de blog
Image de votre article de blog. Url ou contenu de l'image en base64 encode
Possible values: <= 255 characters
Meta title de votre article de blog
Possible values: <= 255 characters
Meta keywords de votre article de blog
Possible values: <= 255 characters
Meta description de votre article de blog
Possible values: [1, 2, 3, 4]
Default value: 1
Possible values: <= 255 characters
URL personnalisée de votre article de blog
Possible values: [1, 0]
Default value: 1
- 1 : L'article de blog est visible sur votre site
- 0 : L'article de blog n'est pas visible sur votre site
Possible values: [1, 0]
- null : Utiliser la configuration par défaut du blog
- 1 : Forcer l'activation des commentaires
- 0 : Forcer la désactivation des commentaires
Date de publication (Date au format ISO 8601)
categories
object[]
Information contenant les catégories
Possible values: <= 30 characters
Titre de votre catégorie de blog
Possible values: <= 100 characters
Titre de la page de votre catégorie de blog
Contenu en haut de la page de votre catégorie de blog
Contenu en bas de la page de votre catégorie de blog
Possible values: <= 255 characters
Meta title de votre catégorie de blog
Possible values: <= 255 characters
Meta keywords de votre catégorie de blog
Possible values: <= 255 characters
Meta description de votre catégorie de blog
Possible values: [1, 2, 3, 4]
Default value: 1
- 1 : La page est référencée par les moteurs de recherche.
- 2 : Ne pas référencer la page et ne pas suivre les liens de la page
- 3 : Ne pas référencer la page
- 4 : Ne pas suivre les liens de la page
Possible values: <= 255 characters
URL personnalisée de votre catégorie de blog
Possible values: [1, 0]
Default value: 1
- 1 : La catégorie de blog est visible sur votre site
- 0 : La catégorie de blog n'est pas visible sur votre site
tags
object[]
Information contenant les tags
Libellé de votre tag de blog
{
"paginator": {
"currentPage": "1",
"itemsPerPage": "50",
"totalItemsCount": "50"
},
"items": [
{
"title": "Mon article de blog",
"shortDescription": "Voici le résumé de mon article de blog",
"description": "<p>Voici le contenu de mon article de blog</p><p>Vous pouvez retrouver toutes les informations sur mon site</p>",
"image": "https://www.url-du-site-de-l-image.fr/mon-image.png",
"metaTitle": "Mon article de blog",
"metaKeywords": "mon article, ma ville, ...",
"metaDescription": "Vous pouvez retrouver toutes les informations dans mon article de blog",
"metaAvailableIndexation": "1",
"linkRewrite": "mon-article-de-blog",
"status": "1",
"activateComment": "1",
"publishedAt": "2024-12-01T09:00:00+00:00",
"id": "1",
"url": "https://www.example.fr/blog/**************-n********.html",
"categories": [
{
"title": "Ma catégorie",
"sectionTitle": "Voici le titre de ma page",
"headerContent": "<p>Contenu de haut de page</p>",
"footerContent": "<p>Contenu de bas de page</p>",
"metaTitle": "ma catégorie de blog",
"metaKeywords": "ma catégorie, ma ville, ...",
"metaDescription": "Vous pouvez retrouver toutes les informations dans ma catégorie de blog",
"metaAvailableIndexation": "1",
"linkRewrite": "ma-categorie-de-blog",
"status": "1",
"id": "1"
}
],
"tags": [
{
"label": "Mon tag",
"id": "1"
}
]
}
]
}
- Schema
- Example (from schema)
Schema
Array [
- 1 : La page est référencée par les moteurs de recherche.
- 2 : Ne pas référencer la page et ne pas suivre les liens de la page
- 3 : Ne pas référencer la page
- 4 : Ne pas suivre les liens de la page
Array [
]
Array [
]
]
paginator
object
Information sur la page courante de votre liste
Information sur le nombre d'éléments affiché sur chaque page
Information sur le nombre total d'éléments qui correspond à votre demande
items
object[]
Possible values: <= 100 characters
Titre de votre article de blog
Possible values: <= 255 characters
Description courte de votre article de blog
Contenu texte de votre article de blog
Image de votre article de blog. Url ou contenu de l'image en base64 encode
Possible values: <= 255 characters
Meta title de votre article de blog
Possible values: <= 255 characters
Meta keywords de votre article de blog
Possible values: <= 255 characters
Meta description de votre article de blog
Possible values: [1, 2, 3, 4]
Default value: 1
Possible values: <= 255 characters
URL personnalisée de votre article de blog
Possible values: [1, 0]
Default value: 1
- 1 : L'article de blog est visible sur votre site
- 0 : L'article de blog n'est pas visible sur votre site
Possible values: [1, 0]
- null : Utiliser la configuration par défaut du blog
- 1 : Forcer l'activation des commentaires
- 0 : Forcer la désactivation des commentaires
Date de publication (Date au format ISO 8601)
categories
object[]
Information contenant les catégories
Possible values: <= 30 characters
Titre de votre catégorie de blog
Possible values: <= 100 characters
Titre de la page de votre catégorie de blog
Contenu en haut de la page de votre catégorie de blog
Contenu en bas de la page de votre catégorie de blog
Possible values: <= 255 characters
Meta title de votre catégorie de blog
Possible values: <= 255 characters
Meta keywords de votre catégorie de blog
Possible values: <= 255 characters
Meta description de votre catégorie de blog
Possible values: [1, 2, 3, 4]
Default value: 1
- 1 : La page est référencée par les moteurs de recherche.
- 2 : Ne pas référencer la page et ne pas suivre les liens de la page
- 3 : Ne pas référencer la page
- 4 : Ne pas suivre les liens de la page
Possible values: <= 255 characters
URL personnalisée de votre catégorie de blog
Possible values: [1, 0]
Default value: 1
- 1 : La catégorie de blog est visible sur votre site
- 0 : La catégorie de blog n'est pas visible sur votre site
tags
object[]
Information contenant les tags
Libellé de votre tag de blog
<root>
<paginator>
<currentPage>1</currentPage>
<itemsPerPage>50</itemsPerPage>
<totalItemsCount>50</totalItemsCount>
</paginator>
<items>
<title>Mon article de blog</title>
<shortDescription>Voici le résumé de mon article de blog</shortDescription>
<description>
<p>Voici le contenu de mon article de blog</p>
<p>Vous pouvez retrouver toutes les informations sur mon site</p>
</description>
<image>https://www.url-du-site-de-l-image.fr/mon-image.png</image>
<metaTitle>Mon article de blog</metaTitle>
<metaKeywords>mon article, ma ville, ...</metaKeywords>
<metaDescription>Vous pouvez retrouver toutes les informations dans mon article de blog</metaDescription>
<metaAvailableIndexation>1</metaAvailableIndexation>
<linkRewrite>mon-article-de-blog</linkRewrite>
<status>1</status>
<activateComment>1</activateComment>
<publishedAt>2024-12-01T09:00:00+00:00</publishedAt>
<id>1</id>
<url>https://www.example.fr/blog/**************-n********.html</url>
<categories>
<title>Ma catégorie</title>
<sectionTitle>Voici le titre de ma page</sectionTitle>
<headerContent>
<p>Contenu de haut de page</p>
</headerContent>
<footerContent>
<p>Contenu de bas de page</p>
</footerContent>
<metaTitle>ma catégorie de blog</metaTitle>
<metaKeywords>ma catégorie, ma ville, ...</metaKeywords>
<metaDescription>Vous pouvez retrouver toutes les informations dans ma catégorie de blog</metaDescription>
<metaAvailableIndexation>1</metaAvailableIndexation>
<linkRewrite>ma-categorie-de-blog</linkRewrite>
<status>1</status>
<id>1</id>
</categories>
<tags>
<label>Mon tag</label>
<id>1</id>
</tags>
</items>
</root>
Problème dans les paramètres :
-
Paramètre manquant
-
Paramètre json ne peut pas être exploité
- application/json
- application/xml
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
{
"error": {
"code": 0,
"message": "string",
"details": [
"string"
]
}
}
{
"error": {
"code": 400,
"message": "PARAMETER_EMPTY",
"details": [
"Paramètre manquant"
]
}
}
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
<error>
<code>0</code>
<message>string</message>
<details>string</details>
</error>
{
"error": {
"code": 400,
"message": "PARAMETER_EMPTY",
"details": [
"Paramètre manquant"
]
}
}
La clé API est invalide
- application/json
- application/xml
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
{
"error": {
"code": 0,
"message": "string",
"details": [
"string"
]
}
}
{
"error": {
"code": 401,
"message": "UNAUTHORIZED",
"details": []
}
}
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
<error>
<code>0</code>
<message>string</message>
<details>string</details>
</error>
{
"error": {
"code": 401,
"message": "UNAUTHORIZED",
"details": []
}
}
Article de blog introuvable
- application/json
- application/xml
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
{
"error": {
"code": 0,
"message": "string",
"details": [
"string"
]
}
}
{
"error": {
"code": 404,
"message": "NOT_FOUND",
"details": [
"Article de blog introuvable"
]
}
}
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
<error>
<code>0</code>
<message>string</message>
<details>string</details>
</error>
{
"error": {
"code": 404,
"message": "NOT_FOUND",
"details": [
"Article de blog introuvable"
]
}
}
Erreur rate limit
- application/json
- application/xml
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
{
"error": {
"code": 0,
"message": "string",
"details": [
"string"
]
}
}
{
"error": {
"code": 429,
"message": "Too Many Requests",
"details": []
}
}
- Schema
- Example (from schema)
- Example
Schema
error
object
Vous aurez le code de l'erreur.
Vous aurez une information détaillée sur le type d'erreur.
<error>
<code>0</code>
<message>string</message>
<details>string</details>
</error>
{
"error": {
"code": 429,
"message": "Too Many Requests",
"details": []
}
}