Appuyez sur / pour rechercher

Toute la documentation
docs Appeler depuis votre logiciel Clés consommateur

S’exécute surWrit Cloud

csk ▸ des clés à distribuer

Donnez l’accès, gardez la main.

Une clé consommateur — préfixe csk_ — est ce avec quoi vos clients appellent vos endpoints publiés. Chaque clé porte ses propres limites et meurt seule ; et elle n’ouvre que la passerelle /v1/{slug}/…, jamais la surface /api de votre compte.

Writ s’exécute sur vos propres comptes, avec vos propres identifiants et données, sur les sites que vous êtes autorisé à utiliser.

clé ▸ émise par vous

Émise par vous, détenue par votre client.

Vous émettez des clés csk_ pour vos propres clients et partenaires. Le secret complet est affiché une seule fois, à l’émission — Writ le stocke haché et ne peut plus le réafficher. Les listes, journaux et analyses identifient une clé par son key_prefix : les 8 premiers caractères, littéralement.

appel ▸ même route

Même route, un Bearer consommateur.

Les appelants touchent exactement le même endpoint — ils envoient simplement leur clé csk_ là où votre clé wt_ ne voyage jamais :

consumer-call.sh · bash
curl -X POST https://api.usewrit.app/v1/acme/price-check \
  -H "Authorization: Bearer csk_77a2...0b4" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/product/42"}'

limites ▸ par clé

Les contrôles qui voyagent avec la clé.

Chaque limite est un champ de la clé elle-même : deux appelants ne partagent jamais le même sort :

ChampDéfautRôle
allowed_endpoint_idsNULLLes endpoints que cette clé peut appeler. NULL = tous vos endpoints.
rate_limit_per_minuteNULL1–10 000 requêtes par minute. NULL = la valeur de l’endpoint, sinon 60/min.
monthly_quotaNULLAppels par mois pour cette clé — monthly_calls_used s’y décompte et se remet à zéro à quota_reset_at. NULL = seul le quota global de votre plan s’applique.
expires_atNULLExpiration ferme optionnelle. NULL = la clé n’expire pas.

cycle de vie ▸ trois états

Suspendre est réversible. Révoquer ne l’est pas.

Une clé est dans exactement un état :

StatutCe que cela signifie
activeLa clé authentifie les appels, dans ses limites.
suspendedCoupée temporairement — réactivez-la plus tard sans rien réémettre.
revokedPermanent. Une clé révoquée ne revient jamais.

La rotation vient avec une fenêtre de grâce : après rotation, la clé précédente continue de fonctionner jusqu’à rotation_grace_until — votre client change d’identifiants sans interruption.

plans ▸ combien de clés

Combien de clés un plan peut porter.

Les clés non révoquées se décomptent de la limite max_consumer_keys de votre plan :

PlanClés consommateur
Free10
Starter20
Pro50
Growth200
ScaleIllimité
EnterpriseIllimité

faq

Vos questions, nos réponses.

En quoi une clé consommateur diffère-t-elle d’une clé wt_ ?
Une clé wt_ est votre propre identifiant pour l’API de la plateforme sur /api/*. Une clé consommateur csk_ est ce que vous émettez pour un client, et elle n’authentifie que vos endpoints publiés /v1/{slug}/… — elle ne peut lire ni votre compte, ni vos workflows, ni vos données.
Quelles limites de débit puis-je définir ?
De 1 à 10 000 requêtes par minute et par clé, appliquées sur une fenêtre glissante de 60 secondes. Au-delà, l’appel répond 429 avec les en-têtes X-RateLimit-* et Retry-After: 60. Laissez NULL pour hériter de la valeur de l’endpoint, ou du défaut de 60/min.
Un consommateur peut-il appeler n’importe lequel de mes endpoints ?
Uniquement ce que permet allowed_endpoint_ids. NULL signifie tous vos endpoints ; fixez la liste, et les appels vers tout le reste sont rejetés.
Comment faire tourner une clé sans casser mon client ?
Faites la rotation : vous recevez le nouveau secret, et l’ancienne clé continue d’authentifier jusqu’à rotation_grace_until. Votre client déploie la nouvelle clé pendant la fenêtre de grâce et ne voit jamais un appel échouer.
Est-ce ainsi que fonctionne aussi le marketplace ?
Non. Le parcours inter-tenant du marketplace est installer puis exécuter : quelqu’un installe votre annonce gratuite et l’exécute sur son propre compte avec ses propres données. Les clés consommateur distribuent l’accès à vos propres endpoints publiés. Writ s’exécute sur vos propres comptes, avec vos propres identifiants et données, sur les sites que vous êtes autorisé à utiliser.

go ▸ distribuer

Distribuez votre première clé.

Publiez un endpoint, émettez une clé csk_ et partagez l’accès sans partager vos secrets.