Aller au contenu
TurnitPass
DéveloppeursAPI v1Obtenir une clé API
Parcourir la documentation

DéveloppeursAuthentification

S’authentifier avec des clés API Bearer

Les requêtes de développement utilisent des clés API générées depuis l’espace de travail TurnitPass.

REST API v1

Auth console

Gardez les clés API hors du navigateur.

Les appels API TurnitPass utilisent une clé Bearer appartenant à l’espace de travail. La clé reste dans du code serveur uniquement ; le tableau de bord reste le lieu pour créer, faire tourner, révoquer et inspecter l’usage.

Garde-fous de clé

Comment sécuriser l’accès

Serveur uniquement

Envoyez les clés depuis des routes backend, workers, jobs ou server actions sécurisées.

Affichée une fois

Copiez immédiatement la clé générée et stockez-la dans votre gestionnaire de secrets.

Rotation sûre

Déployez la clé de remplacement avant de révoquer l’ancienne clé de production.

Portée compte

L’usage se consolide sur le solde de mots et les contrôles de facturation de l’espace de travail.

Requête Bearer

Contrat d’en-tête

Privé par défaut
request
Bearer
fetch('https://turnitpass.com/api/v1/humanize', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer tp_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: draft, language: 'en' })
})
auth en échec
failed auth
401
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}
01Générer dans l’espace de travail
02Stocker dans les secrets
03Appeler depuis le serveur
04Faire tourner ou révoquer

Clés API

Envoyez `Authorization: Bearer tp_your_api_key` avec chaque requête. Les clés sont affichées une seule fois, stockées de façon sécurisée et peuvent être révoquées depuis l’espace de travail.

Authorization header
Bearer
Authorization: Bearer tp_live_your_api_key
Content-Type: application/json

POST /api/v1/humanize
Les clés s’affichent une fois à la création et peuvent être révoquées depuis l’espace de travail sans changer le compte Google.

Managing keys

01

Créer

Générez une clé nommée depuis l’espace de travail et copiez-la immédiatement.

02

Révoquer

Désactivez une clé instantanément. Les clés révoquées ne peuvent plus authentifier de nouvelles requêtes.

03

Limites de débit

Chaque clé peut être limitée indépendamment, tandis que l’usage se consolide sur le compte.

04

Facturation

Toutes les clés partagent le solde de mots et les limites d’abonnement du compte.

Propriété de l’espace de travail

Key lifecycle

1

Créer une clé nommée

Choisissez un nom qui décrit l’environnement ou la surface, par exemple Production backend, Staging worker ou Internal QA.

2

La copier une fois dans un magasin de secrets

TurnitPass n’affiche la clé qu’à la création. Stockez-la dans votre fournisseur de déploiement, le gestionnaire de secrets CI ou un fichier .env local.

3

Suivre l’usage via status et facturation

Toutes les clés partagent le solde de mots ; les noms de clé aident à identifier l’intégration active.

4

Faire tourner avant de révoquer

Créez une clé de remplacement, déployez-la, confirmez que le trafic est sain, puis révoquez l’ancienne clé depuis l’espace de travail.

Environment setup

Stockez les clés TurnitPass comme secrets serveur uniquement. Les exemples ci-dessous utilisent des noms génériques pour Next.js, Workers, jobs serveur ou tout runtime backend.

.env
server only
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
Développement local
.env.local ou gestionnaire local de secretsUtilisez une clé hors production, un petit budget de mots et un nom clair.
Déploiements preview
Clé de stagingSéparez le trafic preview pour que les jobs de test ne consomment pas l’usage de production par accident.
Production
Secret backend uniquementLisez la clé uniquement depuis du code serveur de confiance. Ne la transmettez jamais au navigateur.

Security best practices

Côté serveur uniquement
N’exposez jamais les clés dans le code navigateurUtilisez les clés depuis des services backend, jobs ou routes serveur sécurisées.
Variables d’environnement
Utilisez TURNITPASS_API_KEYÉvitez d’écrire des clés live dans le contrôle de version ou les bundles client.
Faire tourner les clés
Créez un remplacement avant de révoquerUtilisez des clés distinctes pour production, staging et développement.
En cas de fuite
Révoquez immédiatementCréez une nouvelle clé depuis l’espace de travail si une clé fuit.

Authentication errors

En-tête manquant
Aucun en-tête Authorization fourni
Mauvais format
L’en-tête ne commence pas par Bearer
Clé invalide
Clé introuvable, révoquée ou malformée
Trop d’échecs
Les tentatives d’auth en échec répétées peuvent être limitées
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

Ensuite, intégrez-le à votre flux.Continuer la lecture