وثائق API
تعمل واجهة JSON النظيفة للغاية استنادًا إلى مفتاح API على إزالة جميع HTML التسويقي وإرجاع البيانات المنظمة التي يمكن للوكيل استهلاكها مباشرة.
كيفية الحصول على مفتاح API
تسجيل حساب ← تسجيل الدخول ← إنشاء مفتاح API بنفسك ، لا تتطلب العملية برمتها مراجعة يدوية وهي متاحة على الفور.
- 1. انقر فوق "تسجيل" في الزاوية اليمنى العليا من موقع الويب لتسجيل حساب (مطلوب بريد إلكتروني للشركة).
- 2. تسجيل الدخول مع البريد الإلكتروني وكلمة المرور.
- 3. انتقل إلى صفحة "طلب مفتاح API",انقر فوق الزر "إنشاء مفتاح API".
- 4. انسخ المفتاح الذي تم إنشاؤه (يتم عرض النص العادي مرة واحدة فقط ، ويجب إعادة إنشاء المفقود).
- 5. يتم استدعاء جميع واجهات / api / v1 / dev / * بحمل التفويض: Bearer < key > في رأس الطلب.
api-key-flow
bash
# 1. تسجيل حساب
curl -X POST "https://api.tikchip.cn/api/v1/auth/register" \
-H "Content-Type: application/json" \
-d '{"email":"you@company.com","password":"YourPass123","password_confirm":"YourPass123","company":"Your Company","username":"yourname"}'
# 2. تسجيل الدخول للحصول على JWT
curl -X POST "https://api.tikchip.cn/api/v1/auth/login" \
-H "Content-Type: application/json" \
-d '{"username":"you@company.com","password":"YourPass123"}'
# → إرجاع data.token (JWT ، المستخدم لواجهات الإدارة اللاحقة)
# 3. إنشاء مفتاح API مع JWT
curl -X POST "https://api.tikchip.cn/api/v1/dev/keys" \
-H "Authorization: Bearer <JWT>" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'
# → إرجاع data.api _ key (tk _ xxx ، معروض مرة واحدة فقط ، احفظ الآن)
# 4. استدعاء واجهة الأعمال مع مفتاح API
curl -H "Authorization: Bearer <API_KEY>" \
"https://api.tikchip.cn/api/v1/dev/search?keyword=STM32"التوثيق
حمل التفويض: < key > للحامل في رأس الطلب ، أو استخدم X-TikChip-Key.
curl
bash
curl -H "Authorization: Bearer $TIKCHIP_API_KEY" \
"https://api.tikchip.cn/api/v1/dev/search?keyword=STM32F103C8T6&in_stock_only=true"نسبة مشاهدة محدودة للحصص
واجهة فئة البحث 60 مرة / دقيقة ؛ submit _ inquiry الافتراضي 20 مرة لكل مفتاح في اليوم. أكثر من الحد يعود 429 وإعادة المحاولة بعد.
429
http
HTTP/1.1 429 Too Many Requests
Retry-After: 12قائمة نقطة النهاية
تقع جميع نقاط النهاية ضمن البادئة / api / v1 / dev وتتطلب مصادقة مفتاح واجهة برمجة التطبيقات الوكيل.
| Tool | Method | Endpoint |
|---|---|---|
| search_components | GET | /api/v1/dev/search |
| get_component_detail | GET | /api/v1/dev/component/{mpn} |
| compare_components | POST | /api/v1/dev/compare |
| check_stock | GET | /api/v1/dev/stock |
| recommend_alternatives | GET | /api/v1/dev/alternatives |
| submit_inquiry | POST | /api/v1/dev/inquiry |
| register_b2b_account | POST | /api/v1/dev/register |
| get_inquiry_messages | GET | /api/v1/dev/inquiry/{id}/messages |
| reply_to_inquiry | POST | /api/v1/dev/inquiry/{id}/reply |
| list_inquiries | GET | /api/v1/dev/inquiries |
| get_bom_price | POST | /api/v1/dev/bom/price |
اكتشاف نقاط النهاية (لا يوجد مفتاح مطلوب)
يمكن للعميل قراءة إمكانيات التعرف على نقطة النهاية العامة التالية تلقائيًا.
discovery
http
GET /api/v1/dev/agent-card.json # الروبوتات الوكيل (الهوية / القدرة / التردد)
GET /api/v1/dev/manifest # قائمة الأدوات المقروءة آليًا
GET /api/v1/dev/openapi # توثيق OpenAPI 3.0- /api/v1/dev/agent-card.jsonAgent Card
- /api/v1/dev/manifestأداة مانيفست
- /api/v1/dev/openapiوثائق OpenAPI
