Référence API — Vue d'ensemble
API REST avec 137 endpoints. Auth Sanctum, JSON, jobs async via 202, actions facturées en crédits.
Rankion fournit une API REST complète avec 137 endpoints sous la version v1. Tout ce que tu peux cliquer dans l'interface web, tu peux aussi l'automatiser via HTTP — générer des articles, suivre la visibilité IA, récupérer des backlinks, étendre des mots-clés, produire des rapports.
- URL de base :
https://rankion.ai/api/v1 - Auth : Bearer-Token via Sanctum (voir Authentification)
- Format : JSON pour toutes les requêtes et réponses
- Scoping par équipe : tous les endpoints sont team-scoped — un accès cross-team renvoie
403
Démarrage rapide
TOKEN="<ton-token-sanctum>"
BASE="https://rankion.ai/api/v1"
curl -H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json" \
"$BASE/projects"
Réponse (abrégée) :
{
"data": [
{ "id": 1, "name": "Mein Projekt", "domain": "example.com" }
],
"meta": { "total": 1, "per_page": 25, "current_page": 1, "last_page": 1 }
}
Sujets
- Authentification & tokens — créer, faire tourner, révoquer des tokens Sanctum Bearer
- Crédits & rate-limits — combien coûte quoi, quand vient le 402, où sont les limites
- Projets — CRUD plus projets de tracking (assistant AI Visibility)
- Articles — générer, scorer, optimiser, repurposer, publier
Conventions de réponse
| Code | Signification |
|---|---|
200 |
Succès, réponse JSON |
201 |
Ressource créée |
202 |
Job async dispatché — la réponse contient un ID à poller |
400 / 422 |
Erreur de validation : {message, errors:{field:[reason]}} |
402 |
Crédits insuffisants — la balance de l'équipe ne suffit pas pour l'action |
403 |
IDOR / mauvaise équipe — le token n'appartient pas à l'équipe concernée |
404 |
Ressource introuvable (ou cross-team masquée — pas de fuite d'existence) |
409 |
Conflit (par ex. l'article est déjà en cours de publication) |
429 |
Rate-limit dépassé |
Jobs async
Toutes les actions de plus de ~10 secondes (génération d'articles, expansion de mots-clés, pull de backlinks, rapports Reality Check, audits de page, …) tournent en jobs de queue. Pattern :
- Tu envoies
POST /v1/articles/{id}/generate→ le serveur répond202 Acceptedavec par ex.{article_id, status: "pending"}. - Tu polles
GET /v1/articles/{id}(ou l'endpoint de statut concerné) toutes les 5 secondes. - Dès que
processing_status == "ready"(oustatus == "completed"), l'action est terminée.
Tu trouveras des patterns de polling concrets (boucles curl) dans les pages de modules et dans le workflow d'articles.
Familles d'outils & leurs endpoints
| Famille | Nombre | Endpoint principal |
|---|---|---|
| AI Visibility Tracking (projets, mots-clés, prompts, sources citées, insights, Reality Check) | ~30 | POST /v1/tracking-projects/analyze |
| Articles (CRUD, generate, score, optimize, repurpose, publish, versions, freshness) | ~17 | POST /v1/articles/{id}/generate |
| SEO Suite (Rank-Tracker, Explorer, Gap, Site-Audit, Backlinks) | ~30 | POST /v1/explorer |
| Mots-clés (recherche & expansion) | 6 | POST /v1/keywords/research |
| Content Intelligence (Storylines, Style-Profiles, Knowledge-Base, Orphan-Scans) | ~14 | POST /v1/projects/{p}/orphan-scans/discover |
| Galerie d'images (CRUD, edit, share, bulk) | ~15 | POST /v1/images/{id}/edit |
| Outils IA (Agentic Chat, AI-Scanner, Humanizer, Content-Optimizer) | ~10 | POST /v1/agentic/chat |
| Competitor / Audit / Community / Site-Monitor | ~15 | POST /v1/content-audits |
| Automatisation (Bulk, Autopilot, Pipelines) | ~10 | POST /v1/bulk-generations |
| Page-Deep-Audit (Vision + render IA) | 3 | POST /v1/page-audit |
| Rapports & corrélation cross-module | 4 | POST /v1/tracking-projects/{id}/generate-report |
| Wiki, Chat-Shares, Plans, Account, intégrations Google | ~20 | GET /v1/wiki/search |
La table complète avec chaque endpoint, schéma de body et coût en crédits se trouve dans la source de vérité unique docs/API_REFERENCE.md — également sous forme de tableaux live sur rankion.ai/settings/api-documentation.
SDKs / Skills
- Skill Claude
rankion-api— nous fournissons un skill prêt à l'emploi (.claude/skills/rankion-api.md) que Claude Code peut utiliser directement pour appeler les endpoints Rankion. - Skill compagnon
rankion-agent— délègue des requêtes multi-étapes complètes à l'agent maître au lieu d'orchestrer les endpoints individuellement. Voir Agentic Chat. - Serveur MCP — l'agent maître est utilisable comme serveur MCP pour des agents IA (
POST /v1/agentic/chat). Un seul endpoint suffit pour atteindre plus de 12 méta-outils.
Continuer avec Authentification.