Aller au contenu
Menu

Rechercher sur le site

Tape pour chercher dans les guides, le blog, l'API et le produit.

↑ ↓ pour naviguer · Entrée pour ouvrir · Échap pour fermer

Référence de l'API

API

Authentification

Authentifiez vos requêtes API avec des clés API

Voir en Markdown

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.

Utilisation

Incluez l'en-tête X-API-Key dans chaque requête :

GET/v1/activities
curl "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.

StatutCodeDescription
401UNAUTHORIZEDClé API manquante ou invalide
429RATE_LIMITEDLimite de débit dépassée (100 req/min)