सामग्री पर जाएँ
मेनू

साइट में खोजें

गाइड, ब्लॉग, API और प्रोडक्ट में खोजने के लिए लिखें।

↑ ↓ से आगे-पीछे · Enter से खोलें · Esc से बंद करें

API रेफ़रेंस

API

ऑथेंटिकेशन

API keys से अपनी API requests ऑथेंटिकेट करें

Markdown के रूप में देखें

TBit API ऑथेंटिकेशन के लिए API keys का इस्तेमाल करती है। हर request में अपनी API key X-API-Key header में भेजें।

अपनी API key देखने के लिए TBit डैशबोर्ड में Settings > API पर जाएँ। हर एजेंट की अपनी अलग API key होती है।

इस्तेमाल

हर request में X-API-Key header भेजें:

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);
  • अपनी API key को कभी भी client-side कोड या पब्लिक repositories में न डालें
  • अपनी API key environment variables में रखें
  • अगर लगे कि API key लीक हो गई है, तो उसे रोटेट करें
  • API requests सिर्फ़ HTTPS पर करें

अपवाद: कैटलॉग पढ़ने वाले endpoints (प्रोडक्ट, कैटेगरी, कार्ट) के लिए API key एक publishable key की तरह काम करती है: यह आपके अकाउंट की पहचान करती है और इस्तेमाल मापती है, और कैटलॉग का डेटा पब्लिक है। इन endpoints के लिए इसे ब्राउज़र कोड से इस्तेमाल करना सुरक्षित है, बिल्कुल Stripe की publishable key की तरह।

स्टेटसकोडविवरण
401UNAUTHORIZEDMissing or invalid API key
429RATE_LIMITEDRate limit exceeded (100 req/min)