Saltar al contenido
Menú

Buscar en el sitio

Escribe para buscar en guías, blog, API y producto.

↑ ↓ para moverte · Enter para abrir · Esc para cerrar

Referencia de la API

API

Autenticación

Autentica tus solicitudes API usando claves API

Ver como Markdown

La API de TBit usa claves API para autenticación. Incluye tu clave API en el encabezado X-API-Key con cada solicitud.

Navega a Ajustes > API en el panel de TBit para revelar tu clave API. Cada agente tiene una clave API única.

Uso

Incluye el encabezado X-API-Key en cada solicitud:

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);
  • Nunca expongas tu clave API en código del lado del cliente o repositorios públicos
  • Usa variables de entorno para almacenar tu clave API
  • Rota tu clave API si sospechas que ha sido comprometida
  • Solo usa HTTPS al hacer solicitudes API

Excepción: para los endpoints de lectura del catálogo (productos, categorías, carritos) la clave API funciona como una clave publicable: identifica tu cuenta y mide el uso, y los datos del catálogo son públicos. Es seguro usarla desde código del navegador para esos endpoints, igual que una clave publicable de Stripe.

EstadoCódigoDescripción
401UNAUTHORIZEDMissing or invalid API key
429RATE_LIMITEDRate limit exceeded (100 req/min)