Guide d'Intégration API

L'API EZIO vous permet de récupérer vos articles optimisés pour les afficher nativement sur votre plateforme. Plusieurs options s'offrent à vous pour l'installation.

Options d'Intégration

1. Intégration Personnalisée (Custom)

Idéal si vous avez une équipe technique. Votre développeur peut utiliser notre API REST pour récupérer les articles au format JSON et les injecter dans votre CMS ou framework (Next.js, React, Laravel, etc.).

2. Service d'Installation EZIO

Vous n'avez pas de développeur disponible ? Un expert EZIO peut s'occuper de l'intégration technique directement sur votre plateforme. Contactez notre équipe pour planifier cette intervention.

3. Plugin WordPress (Bientôt disponible)

Nous développons actuellement un plugin officiel pour WordPress qui permettra d'afficher vos articles EZIO en quelques clics, sans aucune ligne de code.

Paramètres de l'API

Authentification

Toutes les requêtes doivent inclure votre clé API dans l'en-tête HTTP :

x-api-key: VOTRE_CLE_API

Récupérer les articles

Endpoint : GET https://api.ezioseo.com/api/public/v1/articles

Paramètres de requête (Query Params)

Paramètre	Type	Par défaut	Description
`q`	string	-	Recherche par titre ou slug.
`take`	number	50	Nombre d'articles à récupérer (max 100).
`skip`	number	0	Nombre d'articles à ignorer (pagination).
`orderBy`	string	`createdAt`	Tri par : `createdAt`, `publishedAt`, `title`, `views`.
`order`	string	`desc`	Direction du tri : `asc` ou `desc`.

Pagination et Performance

Pour optimiser le chargement (Lazy Load) ou implémenter un "Infinite Scroll", utilisez les paramètres take et skip.

Logique de pagination :

Page 1 : take=10&skip=0
Page 2 : take=10&skip=10
Page 3 : take=10&skip=20

Utilisation du Meta : L'objet meta retourné vous permet de savoir quand arrêter le chargement :

Champ	Type	Description
`total`	number	Nombre total d'articles correspondant à la recherche.
`take`	number	Nombre d'articles retournés dans cette requête.
`skip`	number	Décalage (index de départ) utilisé.

SEO et Indexation (Sitemap)

Pour garantir que Google indexe tous vos articles (même au-delà du dernier lot de 100), nous fournissons un endpoint dédié à la génération de votre sitemap.xml.

Endpoint Sitemap : GET https://api.ezioseo.com/api/public/v1/sitemap

Contrairement à l'endpoint des articles classique, celui-ci renvoie la liste complète de vos slugs actifs et leur date de mise à jour pour que vos robots d'indexation ne ratent aucun contenu.

Conseil d'intégration :

Votre serveur doit récupérer ce flux JSON pour générer dynamiquement votre fichier sitemap :

// Exemple : Récupérer tout pour le sitemap.xml
const { data } = await fetch('https://api.ezioseo.com/api/public/v1/sitemap', { 
  headers: { 'x-api-key': '...' } 
}).then(r => r.json());

// data = [{ url: 'slug-1', lastmod: '2024-03-10' }, ...]

Format de Réponse

L'API retourne un objet JSON contenant vos articles publiés.

Exemple de réponse :

{
  "data": [
    {
      "title": "Comment optimiser votre SEO en 2026",
      "slug": "optimiser-seo-2026",
      "bannerUrl": "https://storage.ezioseo.com/...",
      "keywords": ["SEO", "Marketing"],
      "metaTitle": "Guide SEO 2026 | EZIO",
      "metaDesc": "Découvrez les meilleures stratégies...",
      "publishedAt": "2026-03-20T10:00:00Z",
      "category": "Marketing",
      "readTime": 5
    }
  ],
  "meta": {
    "total": 124,
    "take": 50,
    "skip": 0
  }
}

Référence API