Guide d’intégration

Connecter votre code à l’API REST de Rank Prompt

Amenez la visibilité IA dans vos propres tableaux de bord et pipelines, ou lancez des rapports depuis votre backend, avec une clé à portée limitée et une API /v1 versionnée, documentée en OpenAPI 3.1.

Commencer gratuitement Découvrir la fonctionnalité
API REST

Rank Prompt lit

  • Vos requêtes
  • La clé et ses champs d’accès

Rank Prompt envoie

  • JSON des marques, rapports et citations
  • En-têtes de quota
  • Erreurs structurées
Rank Prompt

Ce que ça fait

  • Gère les marques, les prompts, les rapports, les planifications, les citations, le contenu et les données SEO depuis votre backend.
  • Limite chaque clé aux ressources dont elle a besoin, et en option à une seule marque.
  • Rend les écritures sûres à relancer avec un Idempotency-Key, et permet d’exécuter tout appel en aperçu gratuit avec ?dry_run=true.
  • Publie une spec OpenAPI 3.1 lisible par les machines, avec une page de référence pour chaque endpoint.

Avant de commencer

Forfait Tous les forfaits, gratuit compris

  • Un backend ou un script capable de garder un secret. Les appels depuis le navigateur sont bloqués : l’API fonctionne de serveur à serveur.
  • Une clé API créée dans Développeurs, Clés API, affichée une seule fois à sa création.
  • Tous les forfaits fonctionnent, gratuit compris, avec 1 000 requêtes par mois sur Free.
Configuration

API REST : configuration en 4 étapes

  1. Étape 1

    Créer une clé

    Dans Rank Prompt, ouvrez Développeurs, Clés API et cliquez sur Créer une clé.

    La fenêtre de création de clé API : compte, nom, champs d’accès, restriction de marque facultative et expiration facultative.

  2. Étape 2

    Choisir ses champs d’accès, sa marque et son expiration

    Donnez-lui un nom reconnaissable, le plus petit ensemble de champs d’accès dont l’intégration a besoin, une marque si elle ne doit en atteindre qu’une, et une date d’expiration pour les clés confiées à des prestataires.

  3. Étape 3

    Ranger la clé en lieu sûr

    La clé complète, qui commence par rp_live_, ne s’affiche qu’une fois. Placez-la dans votre gestionnaire de secrets, jamais dans du code exécuté par le navigateur.

  4. Étape 4

    Faire le premier appel

    Appelez GET https://api.rankprompt.com/v1/me avec Authorization: Bearer et votre clé. La réponse confirme que la clé fonctionne et dans quel compte elle agit.

Dépannage

API REST : erreurs et solutions

Voici les messages que l’app affiche, mot pour mot, et ce qui résout chacun d’eux.

  • invalid_api_key: API key is invalid or revoked

    Vérifiez que la clé entière a été copiée, à partir de rp_live_, et qu’elle n’a pas été révoquée dans Développeurs.

  • insufficient_scope: API key does not have the required scope

    Le champ details.required_scope de l’erreur indique le champ d’accès manquant. Créez une clé qui l’inclut.

  • brand_not_authorized: API key is not authorized for this brand

    La clé est limitée à une autre marque. Utilisez une clé pour cette marque, ou une clé sans restriction de marque.

  • request_quota_exceeded: Monthly request quota exceeded

    Le quota mensuel de requêtes du forfait est épuisé. Il se renouvelle avec la période de facturation ; les en-têtes de quota de chaque réponse montrent ce qu’il reste.

  • browser_calls_forbidden: The Public Developer API is server-to-server only. Browser CORS calls are blocked; call /v1 from your backend with a bearer API key.

    Déplacez l’appel dans votre backend et gardez la clé là-bas.

Toutes les intégrations

FAQ

Questions fréquentes : API REST

Encore des questions ? Contactez notre équipe

L’API est-elle incluse dans mon forfait ?

Oui, sur tous les forfaits, gratuit compris. Le forfait fixe le quota mensuel de requêtes, à partir de 1 000 requêtes sur Free, et les appels qui font un travail d’IA utilisent les crédits de votre forfait.

Où se trouve la référence de l’API ?

Sur rankprompt.com/docs/v1, générée à partir de la même spec OpenAPI 3.1 que sert l’API, avec chaque endpoint, champ d’accès, code d’erreur et coût en crédits.

Une clé peut-elle n’atteindre que la marque d’un seul client ?

Oui. Limitez-la à une marque lors de sa création, et toute requête pour une autre marque répond brand_not_authorized, quels que soient les champs d’accès de la clé.

Qu’en est-il des clés créées dans un compte d’équipe ?

Une clé agit dans le compte actif au moment de sa création. GET /v1/me affiche account_id, account_role et account_plan, et la clé cesse de fonctionner si vous quittez ce compte.

Opérationnel en quelques minutes

Créez un compte gratuit, suivez les étapes ci-dessus et voyez ce que la connexion apporte à votre visibilité IA.

Commencer gratuitement Voir les tarifs