Vai al contenuto
Menu

Cerca nel sito

Scrivi per cercare tra guide, blog, API e prodotto.

↑ ↓ per spostarti · Invio per aprire · Esc per chiudere

Riferimento dell'API

API

Autenticazione

Autentica le tue richieste API con le chiavi API

Vedi come Markdown

L'API di TBit usa le chiavi API per l'autenticazione. Includi la tua chiave API nell'header X-API-Key in ogni richiesta.

Vai su Impostazioni > API nel pannello di TBit per vedere la tua chiave API. Ogni agente ha una chiave API unica.

Uso

Includi l'header X-API-Key in ogni richiesta:

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);
  • Non esporre mai la tua chiave API nel codice lato client o in repository pubblici
  • Usa variabili d'ambiente per conservare la tua chiave API
  • Ruota la tua chiave API se sospetti che sia stata compromessa
  • Usa solo HTTPS quando fai richieste API

Eccezione: per gli endpoint di lettura del catalogo (prodotti, categorie, carrelli) la chiave API funziona come una chiave pubblicabile: identifica il tuo account e misura l'uso, e i dati del catalogo sono pubblici. Puoi usarla in sicurezza dal codice del browser per quegli endpoint, proprio come una chiave pubblicabile di Stripe.

StatoCodiceDescrizione
401UNAUTHORIZEDChiave API mancante o non valida
429RATE_LIMITEDLimite di frequenza superato (100 req/min)