Zum Inhalt springen
Menü

Website durchsuchen

Tippe, um Anleitungen, Blog, API und Produkt zu durchsuchen.

↑ ↓ zum Wechseln · Enter zum Öffnen · Esc zum Schließen

API-Referenz

API

Authentifizierung

Authentifiziere deine API-Anfragen mit API-Schlüsseln

Als Markdown ansehen

Die TBit-API authentifiziert über API-Schlüssel. Schick deinen API-Schlüssel bei jeder Anfrage im Header X-API-Key mit.

Geh im TBit-Panel zu Einstellungen > API, um deinen API-Schlüssel anzuzeigen. Jeder Agent hat einen eigenen API-Schlüssel.

Verwendung

Schick den Header X-API-Key bei jeder Anfrage mit:

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);
  • Leg deinen API-Schlüssel niemals in clientseitigem Code oder öffentlichen Repositories offen
  • Speichere deinen API-Schlüssel in Umgebungsvariablen
  • Rotiere deinen API-Schlüssel, wenn du vermutest, dass er kompromittiert wurde
  • Nutze für API-Anfragen ausschließlich HTTPS

Ausnahme: Für die lesenden Katalog-Endpoints (Produkte, Kategorien, Warenkörbe) funktioniert der API-Schlüssel wie ein veröffentlichbarer Schlüssel: Er identifiziert dein Konto und misst die Nutzung, und die Katalogdaten sind öffentlich. Für diese Endpoints kannst du ihn bedenkenlos in Browser-Code verwenden, genau wie einen veröffentlichbaren Schlüssel von Stripe.

StatusCodeBeschreibung
401UNAUTHORIZEDAPI-Schlüssel fehlt oder ist ungültig
429RATE_LIMITEDRate Limit überschritten (100 Anfr./min)