REST API v1 Tous les endpoints + exemples de code →

Référence de l'API

Cette page est la référence développeur de l'API REST v1 : plus de 400 endpoints, authentification par jeton Bearer et accès programmatique à toutes les fonctionnalités.

Intégrez la génération de contenu IA, l'analyse SEO, la recherche de mots-clés et la gestion de contenu dans vos applications. Authentifiez-vous avec des jetons Bearer via Laravel Sanctum.

# Quick Start curl -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ https://rankion.ai/api/v1/team

Commencer gratuitement — API dans le plan Free Tous les endpoints avec exemples de code (cURL · Python · PHP · JavaScript)

Se connecter en 60 secondes

Un jeton Sanctum, trois façons d'y accéder. Tout est inclus dans chaque plan — même le plan gratuit avec 50 crédits.

MCP-Server

Chaque endpoint devient un outil typé pour Claude et les agents IA.

https://rankion.ai/mcp

Claude-Skill

Un fichier markdown unique que Claude Code charge nativement.

https://rankion.ai/claude-skill

OpenAPI-Spec

Lisible par machine pour n8n, Zapier, le connecteur ChatGPT et vos propres agents.

/api/v1/openapi.yaml ↓

# 1) Token holen: Dashboard → Einstellungen → API Tokens # 2) MCP-Server in Claude Code verbinden claude mcp add rankion --transport http https://rankion.ai/mcp \ --header "Authorization: Bearer rk_live_..." # 3) Oder direkt per REST testen (Free-Plan reicht) curl -H "Authorization: Bearer rk_live_..." https://rankion.ai/api/v1/team

Authentification

Toutes les requêtes API nécessitent un jeton Bearer. Créez votre jeton dans Paramètres → Jetons API du tableau de bord.

# Jeden Request mit Bearer Token authentifizieren curl -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ https://rankion.ai/api/v1/team

Remarque: Envoyez Accept: application/json avec chaque requête et, pour les requêtes POST/PUT, ajoutez également Content-Type: application/json.

Erreurs et codes de statut

Code	Signification
`200`	Succès
`201`	Ressource créée
`202`	Accepté – traitement en arrière-plan démarré
`204`	Supprimé (aucun contenu)
`401`	Non authentifié – jeton invalide
`402`	Crédits insuffisants
`403`	Aucune autorisation pour cette ressource
`404`	Ressource introuvable
`422`	Erreur de validation – vérifiez les paramètres
`429`	Limite de requêtes atteinte
`500`	Erreur serveur

Système de crédits

Certains endpoints consomment des crédits. La consommation est vérifiée avant l'exécution. En cas de solde insuffisant, vous recevrez une erreur 402.

Endpoint	Credits
AI Scanner – Détection	2 Credits
AI Scanner – Humanisation	4+ Credits
Recherche de mots-clés	5 Credits
Génération d'images	5 Credits
Content Audit	10 Credits
Génération d'articles	10+ Credits
Bulk Generation	4 / article
Analyse de la concurrence	20 Credits

Team

Récupère des informations sur votre équipe actuelle.

GET /v1/team

Renvoie les informations de l'équipe avec le plan, les crédits et les statistiques.

// Response 200 { "id": 1, "name": "Mein Team", "plan": "pro", "credit_balance": 5000, "members_count": 3, "projects_count": 5, "articles_count": 120 }

Projects

Gérez les projets. Chaque projet possède son propre domaine, sa langue et sa voix de marque.

GET /v1/projects

Liste tous les projets de l'équipe avec leur voix de marque.

GET /v1/projects/{project}

Projet unique avec voix de marque et les 10 derniers articles.

POST /v1/projects

Crée un nouveau projet.

Paramètre	Type	Info
`name`	string	Obligatoire Nom du projet
`domain`	string	Optionnel URL du site
`language`	string	Optionnel de, en, es, fr (par défaut : de)
`description`	string	Optionnel Description du projet

# Beispiel curl -X POST https://rankion.ai/api/v1/projects \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"Mein Blog","domain":"https://blog.example.com","language":"de"}'

PUT /v1/projects/{project}

Met à jour un projet. Mêmes paramètres que POST (tous optionnels).

DEL /v1/projects/{project}

Supprime le projet et toutes les données associées. Irréversible.

Articles

Gérez, notez, optimisez et vérifiez la fraîcheur des articles.

GET /v1/projects/{project}/articles

Liste paginée des articles d'un projet (20 par page).

GET /v1/articles/{article}

Récupère un article unique avec tous les détails (contenu, scores, métadonnées).

POST /v1/projects/{project}/articles

Crée un nouvel article manuellement (non généré).

Paramètre	Type	Info
`title`	string	Obligatoire
`content`	string	Obligatoire Contenu HTML
`target_keyword`	string	Optionnel
`language`	string	Optionnel de, en, es, fr
`status`	string	Optionnel draft, published

PUT /v1/articles/{article}

Met à jour un article (title, content, status, meta_title, meta_description, target_keyword).

DEL /v1/articles/{article}

Supprime un article.

POST /v1/articles/{article}/score

Démarre le scoring SEO en tant que processus en arrière-plan. Renvoie 202 Accepted.

POST /v1/articles/{article}/optimize

Démarre l'optimisation de contenu à partir d'une URL.

Paramètre	Type	Info
`url`	string	Obligatoire URL de l'article existant

GET /v1/articles/{article}/freshness

Vérifie la fraîcheur du contenu : ancienneté, score, statut (fresh/aging/stale/critical).

GET /v1/articles/{article}/link-suggestions

Récupère des suggestions de maillage interne pour un article.

Keywords

Gérez les mots-clés et effectuez une recherche de mots-clés basée sur l'IA.

GET /v1/projects/{project}/keywords

Liste paginée des mots-clés d'un projet.

POST /v1/projects/{project}/keywords

Ajoute un mot-clé.

Paramètre	Type	Info
`keyword`	string	Obligatoire min. 2 caractères
`search_volume`	integer	Optionnel
`difficulty`	integer	Optionnel 0-100
`language`	string	Optionnel de, en, es, fr

DEL /v1/keywords/{keyword}

Supprime un mot-clé.

POST /v1/keywords/research 5 Credits

Recherche de mots-clés basée sur l'IA avec volume de recherche et difficulté.

Paramètre	Type	Info
`keyword`	string	Obligatoire min. 2 caractères
`language`	string	Optionnel de, en, es, fr
`country`	string	Optionnel Code pays (par défaut : de)

# Beispiel curl -X POST https://rankion.ai/api/v1/keywords/research \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{"keyword":"seo optimierung","language":"de"}'

Images

Gérez les images générées.

GET /v1/projects/{project}/images

Liste toutes les images d'un projet.

GET /v1/images/{image}

Récupère une image unique avec ses métadonnées.

DEL /v1/images/{image}

Supprime une image.

Style Profiles

Créez et gérez des profils de style d'écriture pour un contenu cohérent.

GET /v1/projects/{project}/style-profiles

Tous les profils de style d'un projet.

POST /v1/projects/{project}/style-profiles

Crée un profil de style.

Paramètre	Type	Info
`name`	string	Obligatoire
`tone`	string	Optionnel p. ex. professionnel, décontracté, académique
`writing_style`	string	Optionnel
`vocabulary_level`	string	Optionnel
`sentence_structure`	string	Optionnel
`rules`	object	Optionnel Règles personnalisées

PUT /v1/style-profiles/{styleProfile}

Met à jour un profil de style.

DEL /v1/style-profiles/{styleProfile}

Supprime un profil de style.

Knowledge Base

Téléchargez des documents de connaissance utilisés comme contexte lors de la génération de contenu.

GET /v1/projects/{project}/knowledge-base

Liste tous les documents de la base de connaissances.

POST /v1/projects/{project}/knowledge-base

Crée un nouveau document de connaissance.

Paramètre	Type	Info
`title`	string	Obligatoire
`content`	string	Obligatoire Contenu textuel
`type`	string	Optionnel text, url, pdf

DEL /v1/knowledge-base/{knowledgeDocument}

Supprime un document de connaissance.

Link Lists

Listes de liens pour le maillage interne et externe dans les articles générés.

GET /v1/projects/{project}/link-lists

Toutes les listes de liens d'un projet.

POST /v1/projects/{project}/link-lists

Crée une liste de liens.

Paramètre	Type	Info
`name`	string	Obligatoire
`links`	array	Obligatoire Tableau de {url, anchor_text, description}

DEL /v1/link-lists/{linkList}

Supprime une liste de liens.

Goals

Définissez des objectifs de contenu pris en compte lors de la génération.

GET /v1/goals

Liste tous les objectifs (système + personnalisés).

POST /v1/goals

Crée un objectif personnalisé.

Paramètre	Type	Info
`name`	string	Obligatoire
`description`	string	Optionnel
`prompt_instructions`	string	Optionnel Instructions IA
`metrics`	object	Optionnel Métriques

DEL /v1/goals/{goal}

Supprime un objectif personnalisé (les objectifs système sont protégés).

Calendrier éditorial

Gérez le calendrier éditorial pour la planification de contenu.

GET /v1/projects/{project}/calendar

Liste les entrées du calendrier. Filtrez éventuellement avec ?from=2026-01-01&to=2026-03-31.

POST /v1/projects/{project}/calendar

Crée une entrée de calendrier.

Paramètre	Type	Info
`title`	string	Obligatoire
`planned_date`	date	Obligatoire YYYY-MM-DD
`status`	string	Optionnel planned, in_progress, published
`notes`	string	Optionnel

PUT /v1/calendar/{entry}

Met à jour une entrée de calendrier.

DEL /v1/calendar/{entry}

Supprime une entrée de calendrier.

AI Scanner

Détectez et humanisez les textes générés par IA.

POST /v1/ai-scanner/detect 2 Credits

Analyse un texte pour détecter une génération par IA.

Paramètre	Type	Info
`text`	string	Obligatoire min. 50 caractères
`scan_type`	string	Optionnel quick, deep (par défaut : quick)

// Response 200 { "score": 85, "scan_type": "quick", "word_count": 250, "details": { ... } }

POST /v1/ai-scanner/humanize 4+ Credits

Humanise un article (processus en arrière-plan, 202 Accepted).

Paramètre	Type	Info
`article_id`	integer	Obligatoire
`level`	string	Optionnel light, medium, aggressive

Content Audit

Analysez et notez automatiquement le contenu d'un site web.

GET /v1/content-audits

Liste tous les audits de contenu de l'équipe.

POST /v1/content-audits 10 Credits

Démarre un nouvel audit de contenu (processus en arrière-plan).

Paramètre	Type	Info
`source_url`	string	Obligatoire URL du site web à analyser
`type`	string	Optionnel full, quick

GET /v1/content-audits/{audit}

Récupère un audit unique avec toutes les pages analysées.

Analyse de la concurrence

Analysez les concurrents et identifiez les lacunes de contenu.

GET /v1/competitor-analyses

Liste toutes les analyses de la concurrence.

POST /v1/competitor-analyses 20 Credits

Démarre une nouvelle analyse de la concurrence.

Paramètre	Type	Info
`project_id`	integer	Obligatoire
`domain`	string	Obligatoire Domaine sans protocole
`language`	string	Optionnel de, en, es, fr
`competitor_limit`	integer	Optionnel nombre max. de concurrents

GET /v1/competitor-analyses/{analysis}

Récupère le résultat de l'analyse avec les concurrents et les lacunes de contenu.

AI Visibility Tracking

Surveillez la visibilité de votre domaine dans les moteurs de recherche IA (ChatGPT, Perplexity, Gemini).

GET /v1/tracking-projects

Liste tous les projets de suivi avec leurs scores.

GET /v1/tracking-projects/{trackingProject}

Projet de suivi unique avec historique de visibilité et détails des mots-clés.

POST /v1/tracking-projects/{trackingProject}/run

Démarre une exécution de suivi manuelle (processus en arrière-plan).

Génération de contenu

Générez des articles et des images avec l'IA.

POST /v1/generate/article 10+ Credits

Génère un article IA (processus en arrière-plan, 202 Accepted).

Paramètre	Type	Info
`project_id`	integer	Obligatoire
`keyword`	string	Obligatoire Mot-clé principal
`type`	string	Optionnel blog-post, guide, listicle, review, comparison, pillar
`length`	integer	Optionnel 300 à 5000 mots (par défaut : 1500)
`tone`	string	Optionnel p. ex. professional, casual
`language`	string	Optionnel de, en, es, fr

# Beispiel: Blog-Artikel generieren curl -X POST https://rankion.ai/api/v1/generate/article \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{ "project_id": 1, "keyword": "seo optimierung 2026", "type": "guide", "length": 2000, "language": "de" }' // Response 202 { "message": "Article generation queued", "article_id": 42 }

POST /v1/generate/image 5 Credits

Génère une image IA (processus en arrière-plan, 202 Accepted).

Paramètre	Type	Info
`project_id`	integer	Obligatoire
`prompt`	string	Obligatoire Description de l'image
`style`	string	Optionnel photo, illustration, 3d, watercolor

Bulk Generation

Générez plusieurs articles en une seule fois.

GET /v1/bulk-generations

Liste toutes les générations en masse avec leur statut.

POST /v1/bulk-generations 4 / article

Démarre une génération en masse.

Paramètre	Type	Info
`project_id`	integer	Obligatoire
`keywords`	array	Obligatoire Tableau de mots-clés
`settings`	object	Optionnel {type, length, tone, language}

GET /v1/bulk-generations/{bulk}

Récupère le statut d'une génération en masse avec les éléments individuels.

Autopilot

Configurez la génération automatique de contenu selon un calendrier.

GET /v1/autopilot

Liste tous les calendriers Autopilot.

POST /v1/autopilot

Crée un calendrier Autopilot.

Paramètre	Type	Info
`project_id`	integer	Obligatoire
`name`	string	Obligatoire
`frequency`	string	Obligatoire daily, weekly, biweekly, monthly
`keyword_source`	string	Optionnel manual, keyword_list, ai_suggest
`keywords`	array	Optionnel Si manual : tableau de mots-clés
`settings`	object	Optionnel {type, length, tone}

PUT /v1/autopilot/{schedule}

Met à jour le calendrier. En plus : is_active (boolean) pour activer/désactiver.

DEL /v1/autopilot/{schedule}

Supprime le calendrier.

Credits

Consultez le solde et l'historique des crédits.

GET /v1/credits

Récupère le solde actuel et le plan.

// Response 200 { "balance": 5000, "plan": "pro" }

GET /v1/credits/history

Historique des crédits paginé (20 entrées par page).

Blog (Admin)

Gérez les catégories et les articles du blog.

Catégories

GET /v1/blog/categories

Liste toutes les catégories du blog.

POST /v1/blog/categories

Crée une catégorie.

Paramètre	Type	Info
`name`	string	Obligatoire
`slug`	string	Optionnel (généré automatiquement)
`description`	string	Optionnel

PUT /v1/blog/categories/{category}

Met à jour une catégorie.

DEL /v1/blog/categories/{category}

Supprime une catégorie.

Posts

GET /v1/blog/posts

Liste tous les articles du blog (paginé).

GET /v1/blog/posts/{post}

Récupère un article de blog unique.

POST /v1/blog/posts

Crée un article de blog.

Paramètre	Type	Info
`title`	string	Obligatoire
`content`	string	Obligatoire
`category_id`	integer	Optionnel
`status`	string	Optionnel draft, published
`locale`	string	Optionnel de, en, es, fr

PUT /v1/blog/posts/{post}

Met à jour un article de blog.

DEL /v1/blog/posts/{post}

Supprime un article de blog.

Health Check

Endpoint public (aucun jeton requis) pour la surveillance.

GET /api/health

Renvoie le statut du serveur. Aucune authentification requise.

// Response 200 { "status": "ok", "timestamp": "2026-02-24T12:00:00Z" }

Prêt à utiliser l'API ?

Crée un compte gratuit, récupère ton token dans Paramètres → API et lance-toi. 50 crédits gratuits, sans carte.

Commencer gratuitement — API dans le plan Free Tous les endpoints avec exemples de code (cURL · Python · PHP · JavaScript)