API
المصادقة
صادِق طلباتك إلى الـ API باستخدام مفاتيح API
# المصادقة > صادِق طلباتك إلى الـ API باستخدام مفاتيح API - الصفحة: https://tbit.app/ar/docs/api/authentication - عنوان URL الأساسي: `https://rest-api.tbit.app/v1` - المصادقة: ترويسة `X-API-Key` تحمل مفتاحك في كل طلب (تقرأه الأمثلة من متغير البيئة `TBIT_API_KEY`) ## نظرة عامة تستخدم واجهة TBit API مفاتيح API للمصادقة. ضع مفتاح API الخاص بك في ترويسة X-API-Key مع كل طلب. ## احصل على مفتاح API انتقل إلى الإعدادات > API في لوحة تحكم TBit لإظهار مفتاح API. لكل وكيل مفتاح API فريد. ## الاستخدام أضف ترويسة X-API-Key إلى كل طلب: `GET /v1/activities` ```bash curl "https://rest-api.tbit.app/v1/activities" \ -H "X-API-Key: $TBIT_API_KEY" ``` ## أفضل ممارسات الأمان - لا تكشف مفتاح API أبدًا في كود يعمل في المتصفح أو في مستودعات عامة - استخدم متغيرات البيئة لتخزين مفتاح API - بدّل مفتاح API إذا شككت في أنه تسرّب - استخدم HTTPS فقط عند إرسال طلبات إلى الـ API ## استخدام المفتاح كمفتاح قابل للنشر في نقاط نهاية الكتالوج استثناء: في نقاط نهاية قراءة الكتالوج (المنتجات، والفئات، والسلال) يعمل مفتاح API كمفتاح قابل للنشر: يعرّف حسابك ويقيس الاستخدام، وبيانات الكتالوج عامة أصلًا. لذلك يمكنك استخدامه بأمان من كود المتصفح لهذه النقاط، تمامًا مثل المفتاح القابل للنشر في Stripe. ## أخطاء المصادقة | الحالة | الرمز | الوصف | | --- | --- | --- | | `401` | `UNAUTHORIZED` | مفتاح API مفقود أو غير صالح | | `429` | `RATE_LIMITED` | تم تجاوز حد معدّل الطلبات (100 طلب/دقيقة) |تستخدم واجهة TBit API مفاتيح API للمصادقة. ضع مفتاح API الخاص بك في ترويسة X-API-Key مع كل طلب.
انتقل إلى الإعدادات > API في لوحة تحكم TBit لإظهار مفتاح API. لكل وكيل مفتاح API فريد.
أضف ترويسة X-API-Key إلى كل طلب:
/v1/activitiescurl "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 أبدًا في كود يعمل في المتصفح أو في مستودعات عامة
- استخدم متغيرات البيئة لتخزين مفتاح API
- بدّل مفتاح API إذا شككت في أنه تسرّب
- استخدم HTTPS فقط عند إرسال طلبات إلى الـ API
استثناء: في نقاط نهاية قراءة الكتالوج (المنتجات، والفئات، والسلال) يعمل مفتاح API كمفتاح قابل للنشر: يعرّف حسابك ويقيس الاستخدام، وبيانات الكتالوج عامة أصلًا. لذلك يمكنك استخدامه بأمان من كود المتصفح لهذه النقاط، تمامًا مثل المفتاح القابل للنشر في Stripe.
| الحالة | الرمز | الوصف |
|---|---|---|
401 | UNAUTHORIZED | مفتاح API مفقود أو غير صالح |
429 | RATE_LIMITED | تم تجاوز حد معدّل الطلبات (100 طلب/دقيقة) |