API
Authentification
Authentifiez vos requêtes API avec des clés API
# Authentification > Authentifiez vos requêtes API avec des clés API - Page: https://tbit.app/fr/docs/api/authentication - URL de base: `https://rest-api.tbit.app/v1` - Authentification: en-tête `X-API-Key` avec votre clé dans chaque requête (les exemples la lisent depuis la variable d'environnement `TBIT_API_KEY`) ## Vue d'ensemble L'API TBit utilise des clés API pour l'authentification. Incluez votre clé API dans l'en-tête X-API-Key de chaque requête. ## Obtenir votre clé API Allez dans Paramètres > API dans le panneau TBit pour afficher votre clé API. Chaque agent a une clé API unique. ## Utilisation Incluez l'en-tête X-API-Key dans chaque requête : `GET /v1/activities` ```bash curl "https://rest-api.tbit.app/v1/activities" \ -H "X-API-Key: $TBIT_API_KEY" ``` ## Bonnes pratiques de sécurité - N'exposez jamais votre clé API dans du code côté client ni dans des dépôts publics - Utilisez des variables d'environnement pour stocker votre clé API - Changez votre clé API si vous pensez qu'elle a été compromise - N'utilisez que HTTPS pour vos requêtes API ## Usage publiable pour les endpoints du catalogue Exception : pour les endpoints de lecture du catalogue (produits, catégories, paniers), la clé API fonctionne comme une clé publiable : elle identifie votre compte et mesure l'usage, et les données du catalogue sont publiques. Vous pouvez l'utiliser sans risque depuis du code navigateur pour ces endpoints, comme une clé publiable Stripe. ## Erreurs d'authentification | Statut | Code | Description | | --- | --- | --- | | `401` | `UNAUTHORIZED` | Clé API manquante ou invalide | | `429` | `RATE_LIMITED` | Limite de débit dépassée (100 req/min) |L'API TBit utilise des clés API pour l'authentification. Incluez votre clé API dans l'en-tête X-API-Key de chaque requête.
Allez dans Paramètres > API dans le panneau TBit pour afficher votre clé API. Chaque agent a une clé API unique.
Incluez l'en-tête X-API-Key dans chaque requête :
/v1/activitiescurl "https://rest-api.tbit.app/v1/activities" \
-H "X-API-Key: $TBIT_API_KEY"const response = await fetch('https://rest-api.tbit.app/v1/activities', {
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
},
});
const data = await response.json();import axios from 'axios';
const { data } = await axios.get(
'https://rest-api.tbit.app/v1/activities',
{
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
},
},
);import os
import requests
response = requests.get(
'https://rest-api.tbit.app/v1/activities',
headers={'X-API-Key': os.environ['TBIT_API_KEY']},
)
data = response.json()<?php
$ch = curl_init('https://rest-api.tbit.app/v1/activities');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('TBIT_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);- N'exposez jamais votre clé API dans du code côté client ni dans des dépôts publics
- Utilisez des variables d'environnement pour stocker votre clé API
- Changez votre clé API si vous pensez qu'elle a été compromise
- N'utilisez que HTTPS pour vos requêtes API
Exception : pour les endpoints de lecture du catalogue (produits, catégories, paniers), la clé API fonctionne comme une clé publiable : elle identifie votre compte et mesure l'usage, et les données du catalogue sont publiques. Vous pouvez l'utiliser sans risque depuis du code navigateur pour ces endpoints, comme une clé publiable Stripe.
| Statut | Code | Description |
|---|---|---|
401 | UNAUTHORIZED | Clé API manquante ou invalide |
429 | RATE_LIMITED | Limite de débit dépassée (100 req/min) |