Aller au contenu
TrimCarbon API
Esc
↑↓naviguer↵ouvrir⌘Japerçu
Sur cette page

Authentification

Clés d’API, modes Réel et Test, et niveaux d’accès.

Envoyez votre clé comme jeton bearer dans chaque requête :

Authorization: Bearer tc_live_…

X-Api-Key: tc_live_… fonctionne aussi.

Clés réelles et clés de test

Le préfixe vous indique d’un coup d’œil le mode d’une clé :

  • tc_live_… débite votre solde réel et retire de vrais crédits. Les réponses indiquent "livemode": true.
  • tc_test_… débite un solde simulé. Les réponses indiquent "livemode": false. Consultez Mode test.

Les données réelles et les données de test sont séparées : une clé de test ne voit jamais les compensations réelles, et inversement.

Accès

Chaque clé dispose de l’un des deux niveaux d’accès, défini lors de sa création :

Accès Permet de
Lecture seule Consulter le solde, les devis, les compensations et l’impact.
Lecture et achat Faire tout ce qui précède, et acheter des compensations.

Attribuez une clé en lecture seule aux tableaux de bord et aux rapports. Un achat effectué avec une clé en lecture seule échoue avec 403 insufficient_permissions.

Gardez vos clés secrètes

  • Utilisez vos clés uniquement sur votre serveur. L’API n’envoie aucun en-tête CORS : les navigateurs ne peuvent donc pas l’appeler avec une clé.
  • Stockez vos clés comme des secrets (variables d’environnement, gestionnaire de secrets), jamais dans le code.
  • Créez une clé par système, afin de pouvoir en révoquer une sans toucher aux autres.
  • Si une clé est divulguée, révoquez-la immédiatement sur la page Développeurs. Les requêtes qui l’utilisent échouent dès lors. Vous êtes responsable des achats effectués avec vos clés.

Erreurs

Statut Code Quand
401 invalid_api_key La clé est absente, mal formée, inconnue ou révoquée.
403 api_access_inactive Le compte n’est pas approuvé, ou il est suspendu. Un compte suspendu conserve l’accès en lecture.
403 insufficient_permissions Une clé en lecture seule a tenté d’acheter.
429 rate_limited Trop de requêtes pour cette clé. Consultez Limites.

Cette page vous a-t-elle été utile ?