Pular para o conteúdo
Menu

Buscar no site

Digite para buscar em guias, blog, API e produto.

↑ ↓ para navegar · Enter para abrir · Esc para fechar

Referência da API

API

Autenticação

Autentique as suas requisições à API com chaves de API

Ver como Markdown

A API do TBit usa chaves de API para autenticação. Inclua a sua chave de API no cabeçalho X-API-Key em cada requisição.

Vá em Configurações > API no painel do TBit para revelar a sua chave de API. Cada agente tem uma chave de API única.

Uso

Inclua o cabeçalho X-API-Key em cada requisição:

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 exponha a sua chave de API em código do lado do cliente nem em repositórios públicos
  • Use variáveis de ambiente para guardar a sua chave de API
  • Troque a sua chave de API se suspeitar que ela foi comprometida
  • Use apenas HTTPS ao fazer requisições à API

Exceção: nos endpoints de leitura do catálogo (produtos, categorias, carrinhos) a chave de API funciona como uma chave publicável: identifica a sua conta e mede o uso, e os dados do catálogo são públicos. É seguro usá-la em código do navegador para esses endpoints, igual a uma chave publicável do Stripe.

StatusCódigoDescrição
401UNAUTHORIZEDChave de API ausente ou inválida
429RATE_LIMITEDLimite de taxa excedido (100 req/min)