Glossaire

Un référentiel des termes que vous rencontrerez dans la documentation, le tableau de bord et les réponses API.

Une chaîne secrète utilisée pour authentifier les requêtes API. Chaque clé appartient à un tenant et possède un alias, une catégorie, des quotas optionnels et une date d'expiration optionnelle. Transmise via l'en-tête x-api-key ou le paramètre de requête x_api_key.

Consultez Clés API pour tous les détails.

API Stats

Un point d'accès gratuit qui renvoie la santé d'infrastructure de la plateforme pour un moteur ou un chemin, sur la dernière heure. Ce n'est pas l'usage de votre compte ou tenant. L'accès est activé par compte. Un HTTP 403 signifie qu'il n'est pas actif sur votre compte : contactez le support pour l'activer.

Voir Stats.

Pack ponctuel

Un pack API ponctuel. Les packs ne se réinitialisent pas chaque période. Les appels consomment d'abord le quota abonnement, puis le pack ponctuel (dans l'ordre d'achat) jusqu'à épuisement.

Achetez des packs depuis la facturation du tableau de bord ou la page tarifs.

Alias

Le nom lisible d'une clé API, unique au sein d'un tenant. Utilisé pour identifier les clés dans le tableau de bord et les analyses.

Rechargement automatique

Fonctionnalité qui achète automatiquement un pack ponctuel lorsque votre solde restant (quota abonnement + pack ponctuel + crédits) passe sous un seuil. Protégée par un délai de 72 heures entre les achats. Nécessite un abonnement payant actif.

Consultez Rechargement automatique pour tous les détails.

Période de facturation

La fenêtre d'abonnement active utilisée pour mesurer la consommation de quota. Déterminée par les champs currentPeriodStart et currentPeriodEnd de Stripe. En l'absence d'abonnement actif, la période de facturation correspond au mois civil en cours.

Catégorie

Une étiquette sur une clé API (production, development, staging ou personnalisée). Utilisée pour le filtrage et l'organisation dans le tableau de bord. Ne modifie pas le traitement de la requête par l'API.

Crédit

L'unité de consommation de l'API. Chaque requête facturable déduit un nombre de crédits déterminé par le coût du point d'accès. Les crédits sont stockés sous forme d'entrées de grand livre : un montant négatif signifie que des crédits ont été accordés, un montant positif signifie qu'ils ont été consommés.

Consultez Crédits pour le coût par point d'accès.

Crédits

Crédits stockés dans un solde séparé. Utilisés uniquement après épuisement du quota abonnement et du pack ponctuel. Ils ne se réinitialisent pas à la fin d'une période de facturation. Sources : l'inscription ou un achat manuel.

Quota par clé

Une limite de requêtes optionnelle définie sur une clé API spécifique. Appliquée sur des fenêtres glissantes : total depuis toujours, dernières 24 heures, 7 jours et 30 jours. Indépendante du quota d'abonnement.

Plan

Un produit d'abonnement (ex. "Starter", "Pro") qui définit un ensemble de fonctionnalités : quota d'appels API, limites de débit, accès aux crédits, etc. Un tenant peut détenir plusieurs produits de plan actifs simultanément.

Quota

Budget combiné d'appels API (quota abonnement + packs restants), pondéré par le coût en crédits de chaque point d'accès. Le quota abonnement se renouvelle à chaque période ; les packs sont consommés une fois. Lorsque les deux sont épuisés, les crédits sont utilisés s'il en reste ; sinon les requêtes retournent 402.

Limite de débit

Il existe deux systèmes de limitation de débit distincts. Les limites de plan (par seconde / par minute) s'appliquent à toutes les clés d'un compte et sont définies par le plan d'abonnement. Les quotas par clé (fenêtres glissantes total / quotidien / hebdomadaire / mensuel) sont des plafonds optionnels configurés par clé. Les deux retournent 401 avec un message Rate limit exceeded : le message indique laquelle des deux limites a été atteinte. Voir Clés API pour les détails.

Abonnement

Un arrangement de facturation récurrent liant un tenant à un ou plusieurs plans. Géré via Stripe. Détermine la période de facturation, le quota et les fonctionnalités disponibles pour le tenant.

Tenant

L'unité organisationnelle de la plateforme, équivalente à un compte ou un espace de travail. Toutes les clés API, l'utilisation, les crédits et les abonnements sont limités à un tenant. Les utilisateurs peuvent appartenir à plusieurs tenants. Voir Compte.

Seuil

Le pourcentage de solde restant (quota abonnement + pack ponctuel + crédits) auquel le rechargement automatique s'active. Configurable entre 10 % et 30 %.