Aller au contenu principal

Authentification

Développeurs

L'URL de base est https://app.citeme.io/api/v1. Toutes les requêtes exigent un en-tête Authorization: Bearer cm_....

curl https://app.citeme.io/api/v1/projects \
-H "Authorization: Bearer cm_xxxxxxxxxxxx"

Forfaits​

L'API publique, le serveur MCP hébergé et la CLI sont ouverts sur tous les forfaits payants, et fermés sur le forfait Free. Les autres pages de la documentation développeurs renvoient à ce tableau.

SurfaceFreeForfait payant
API publique (/api/v1/projects/*, clé cm_)Refusée : pas de création de clé, et toute requête reçoit 403Lecture et écriture, selon le scope de la clé
Serveur MCP hébergé (https://mcp.citeme.io)Connexion refusée, avec un lien vers la page des tarifsTous les outils, selon le rôle
CLI citeme et paquet MCP local (/api/v1/cli/*, clé de citeme login)Refusée, 403Toutes les commandes, selon le rôle

Le forfait est revérifié à chaque appel : une clé créée sous un abonnement cesse de fonctionner si l'organisation repasse en Free. Le refus est un 403 qui nomme ce qui manque :

{
"error": "…",
"feature": "apiAccess",
"requiredPlan": "…"
}

feature nomme la fonction refusée (apiAccess pour l'API publique, mcpAccess pour le MCP), requiredPlan le forfait qui l'ouvre. Un agent peut s'arrêter sur ces deux champs plutôt que sur le message.

Les quotas (audits, prompts, moteurs) sont ceux du forfait, les mêmes que dans le dashboard. L'analyse du code de citeme audit n'a pas de quota à part : elle compte dans le quota d'audits du dashboard.


Créer une clé​

Réglages → Espace de travail → Clés API. La clé n'est affichée qu'une fois, juste après sa création.

  • Format : cm_ suivi de 48 caractères hexadécimaux.
  • Forfait : un forfait payant, voir Forfaits.
  • Lecture seule par défaut : à la création, vous choisissez entre une clé en lecture seule (scope read) et une clé qui autorise aussi les écritures (scopes read et write). Le scope ne dépend pas du forfait.
  • Durée : une clé expire un an après sa création. Les clés créées avant le 2 novembre 2026 n'expirent pas.
  • Révocation : le bouton Révoquer de la même page. La clé est refusée dès l'appel suivant.
Ne jamais exposer votre clé

Ne l'incluez jamais dans du code côté client ni dans un dépôt public.

Qui peut créer une clé​

RôleClé cm_
Propriétaire, Administrateur de l'organisationCrée et révoque les clés de l'organisation
Membre, LecteurNe crée pas de clé
Invité Admin d'une seule marque, sans siège dans l'organisationCrée une clé limitée à cette marque, et ne voit que les clés de cette marque

Une clé limitée à une marque ne voit que cette marque dans GET /projects, et reçoit 403 Forbidden: This API key is restricted to another brand sur toute autre marque.

Une clé suit son créateur. Une clé d'organisation est refusée dès que son créateur n'est plus Propriétaire ni Administrateur, qu'il ait quitté l'organisation ou changé de rôle. Une clé de marque est refusée dès que l'invité ne gère plus cette marque. Les prompts créés par l'API sont rattachés au créateur de la clé.


Scopes​

RequêteScope exigéRéponse si absent
Toute requêteread403 Forbidden: This API key does not have read permissions
POST (lancer un audit, ajouter un mot-clé)write, en plus de read403 Forbidden: This API key does not have write permissions

Une clé en lecture seule ne peut donc que lister et lire. Pour lancer un audit par API, créez une clé avec écriture.

Une clé expirée, révoquée, inconnue ou dont le créateur a perdu ses droits reçoit 401 Unauthorized: Invalid API key.


Quelle clé pour quelle surface​

CiteMe a deux systèmes de clés, volontairement séparés. Chacun refuse les routes de l'autre.

Clé API cm_Clé de citeme login
CréationRéglages → Espace de travail → Clés APIcommande citeme login (CLI, extension Chrome, MCP local)
QuiPropriétaire ou Administrateur, ou invité Admin d'une marqueTout membre de l'organisation
DroitsLe scope de la clé : read, ou read et writeLe rôle : Propriétaire, Administrateur et Membre lisent et modifient, Lecteur lit seulement
DuréeUn an90 jours
RévocationRéglages → Clés APIRéglages → Outils développeur, section Outils connectés
Routes acceptées/api/v1/projects/* (cette documentation)/api/v1/cli/*
Serveur MCP hébergé (https://mcp.citeme.io)refuséeacceptée comme Bearer

Une clé de citeme login appelée sur /api/v1/projects est refusée, et une clé cm_ appelée sur /api/v1/cli/* aussi. Une personne invitée sur une seule marque, sans siège dans l'organisation, ne peut pas utiliser citeme login : elle passe par une clé cm_.

Clés de citeme login et CI​

Chaque citeme login crée sa propre clé. Se connecter sur un deuxième poste ne révoque ni la clé du premier, ni celle que vous avez mise dans les secrets de votre CI : les anciennes clés restent valides jusqu'à leurs 90 jours, ou jusqu'à ce que vous les révoquiez dans Outils connectés.

Pour un CI, lancez citeme login une fois, copiez apiKey depuis le fichier affiché par citeme config dans un secret, et révoquez cette clé dans Outils connectés quand le CI n'en a plus besoin. La mise en place est décrite dans la CLI.

Pour piloter CiteMe depuis un agent IA, voir Piloter CiteMe depuis un agent IA.


Marques →