REST API

اپنے Skimle پروجیکٹس پر تعمیر کریں

پروجیکٹ ڈیٹا پڑھنے اور لکھنے، اور کسی پروجیکٹ کو شروع سے آخر تک چلانے کے لیے JSON اینڈ پوائنٹس۔ Bearer کلید سے تصدیق کریں، ایک action بھیجیں، JSON واپس پائیں۔

تین مراحل میں شروع کریں

صفر سے آپ کی پہلی تصدیق شدہ کال تک۔

1

API کلید بنائیں

پروجیکٹ کلید ایک پروجیکٹ تک رسائی دیتی ہے۔ اکاؤنٹ کلید ایک ٹیم تک رسائی دیتی ہے اور اس میں پروجیکٹس بنا سکتی ہے۔ دونوں پڑھنے اور ترمیم کی سطحوں میں آتی ہیں۔

  1. 1. API کلیدوں کا صفحہ کھولیں
  2. 2. وہ پروجیکٹ منتخب کریں جس تک کلید رسائی دے گی اور پڑھنے یا ترمیم کی اجازت منتخب کریں
  3. 3. کلید کاپی کریں، Skimle صرف اس کا ہیش محفوظ کرتا ہے

کلید فوراً کاپی کریں۔

مکمل کلید صرف بناتے وقت ایک بار دکھائی جاتی ہے۔ ڈائیلاگ بند کرنے کے بعد ہمارے پاس صرف ہیش رہتا ہے، کھوئی ہوئی کلید دوبارہ جاری کرنی پڑتی ہے۔

2

اپنی پہلی درخواست بھیجیں

کلید کو Bearer ٹوکن کے طور پر اور action کو JSON باڈی میں بھیجیں۔ ہر اینڈ پوائنٹ JSON لیتا اور JSON لوٹاتا ہے۔

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

پڑھنے کی کلیدیں r پر اور ترمیم کی کلیدیں e پر ختم ہوتی ہیں۔ پروجیکٹ کلیدیں /api/skimle-read اور /api/skimle-write کو کال کرتی ہیں۔ اکاؤنٹ کلیدیں /api/skimle-account کو کال کرتی ہیں۔

3

API حوالہ کھولیں

تفصیل، درخواست کی ساخت اور آزمانے کے پینل کے ساتھ ہر اینڈ پوائنٹ دیکھیں۔ ہر روٹ action پر مبنی discriminated union باڈی قبول کرتا ہے۔

خام OpenAPI 3.1 اسپیک یہاں دستیاب ہے: /api/openapi.json.

تعمیر کے لیے تیار ہیں؟

اپنی پروجیکٹ کلیدوں کا انتظام کریں، یا ایجنٹک کلائنٹس کے لیے MCP سرور دیکھیں۔