API کلیدوں سے اپنا سافٹ ویئر جوڑیں

پبلک API آپ کے اپنے سافٹ ویئر کو، یا آپ کے ڈویلپر کے سافٹ ویئر کو، آپ کے Kluvan ریکارڈ پڑھنے اور لکھنے دیتی ہے: پروڈکٹس، گاہک، اسٹاک، رپورٹس، حسابات کی دستاویزات، ایچ آر کے لوگ، CRM، سبسکرپشنز اور آپ کی موجود ایپس۔ ہر کلید آپ کے کنٹرول میں ہے: وہ کیا کر سکتی ہے، کتنی دیر کے لیے اور کس برانچ کے لیے۔

شروع کرنے سے پہلے

• صرف مالک کلیدیں بنا اور منسوخ کر سکتا ہے۔
• کلید کبھی وہ ایپ نہیں کھولتی جو آپ کے ادارے کے پاس نہیں، اور آپ کے پلان، آپ کی ایپس اور آپ کی برانچوں کا ہر قاعدہ پھر بھی لاگو رہتا ہے۔

مراحل

1. ترتیبات ← ڈویلپر رسائی کھولیں۔
2. نئی کلید کے نیچے ایک نام لکھیں جسے آپ پہچان لیں، مثلاً "گودام کا اسکینر"۔
3. میعاد کے دن (1–365) سیٹ کریں۔ پہلے سے 90 ہوتا ہے۔
4. برانچ کے نیچے تمام برانچیں رہنے دیں یا ایک برانچ چنیں۔
5. دیکھ سکتا ہے کے نیچے ہر وہ دائرہ ٹک کریں جس کی کلید کو ضرورت ہے۔ ہر ایک پر پڑھنا یا لکھنا لکھا ہوتا ہے، مثلاً پروڈکٹس · پڑھنا۔
6. اس جملے پر ٹک کریں کہ آپ منتخب رسائی کی اجازت دیتے ہیں۔
7. کلید بنائیں دبائیں۔
8. کلید ابھی کاپی کریں۔ یہ صرف اسی ایک بار دکھائی جاتی ہے۔
9. کلید اپنے سافٹ ویئر کو دیں۔ وہ اسے Authorization: Bearer ہیڈر میں بھیجتا ہے۔

API کو کال کرنا

• پتہ https://api.kluvan.com/v1/public-api ہے۔ ڈویلپر رہنما (/developers) مثالیں، اور ہر آپریشن اس کے لیے درکار دائرے کے ساتھ، دکھاتا ہے۔ OpenAPI 3.1 پورا معاہدہ، درخواست کے فیلڈز کے ساتھ، ڈاؤن لوڈ کرتا ہے۔
• ہر لکھنے کے لیے Idempotency-Key چاہیے: ہر تبدیلی کے لیے ایک نیا UUID۔ اگر جواب کھو جائے تو 7 دن تک وہی درخواست اسی کلید کے ساتھ دوبارہ بھیجیں؛ یہ دو بار لاگو نہیں ہوتی۔ بدلی ہوئی درخواست کے ساتھ وہی کلید رد ہو جاتی ہے۔
• کسی موجودہ ریکارڈ میں تبدیلی ریکارڈ کا موجودہ ورژن (v) بھی بھیجتی ہے، تاکہ کوئی پرانی کاپی کبھی نئی پر نہ لکھ دے۔
• رقمیں کرنسی کی سب سے چھوٹی اکائی میں ہوتی ہیں (150.00 کا مطلب 15000)۔
• ایپ کے ریکارڈز کی فہرستیں زیادہ سے زیادہ 50 ریکارڈز اور ایک next ویلیو واپس کرتی ہیں؛ اگلا صفحہ لینے کے لیے اسے after کے طور پر بھیجیں۔
• ہر کلید کے لیے فی منٹ 120 درخواستوں تک۔ اس سے آگے جواب 429 ہوتا ہے، Retry-After کے ساتھ۔ ہر غلطی کے ساتھ ایک کوڈ ہوتا ہے (دیکھیں غلطیوں کا رہنما)۔

جاننے کی باتیں

• لکھنے کے دائرے اصل ریکارڈ بدلتے ہیں اور کسی ایپ کے کام چلا سکتے ہیں، ان کے اسٹاک اور اکاؤنٹنگ کے اثرات کے ساتھ۔ کلید کو صرف وہی دائرے دیں جن کی اسے ضرورت ہے۔
• برانچ کی کلیدیں صرف برانچ کے ریکارڈ پڑھتی ہیں۔ کیٹلاگ، گاہک، CRM، ایچ آر اور سبسکرپشن کے آپریشنز کے لیے تمام برانچوں والی کلید چاہیے۔
• Kluvan ہر کلید کا صرف ایک فنگر پرنٹ (hash) رکھتا ہے۔ کلید کھو گئی؟ اسے منسوخ کریں اور نئی بنائیں۔
• منسوخ کریں کلید کو فوراً روک دیتا ہے۔ کلید اپنے آخری دن بھی رک جاتی ہے۔ آپ زیادہ سے زیادہ 20 کلیدیں رکھ سکتے ہیں۔
• API سرگرمی میں ہر کال کی فہرست ہوتی ہے: وقت، آپریشن، کلید اور اسٹیٹس۔ درخواستوں کا مواد اور کلیدیں کبھی درج نہیں ہوتیں۔
• API بلنگ، لاگ ان، ادائیگی وصول کرنا یا ویب ہُکس پیش نہیں کرتی: باہر جانے والی کوئی اطلاع نہیں، اس لیے آپ کا سافٹ ویئر اپنی ضرورت کی فہرستیں خود پڑھتا ہے۔
• لاگ ان شدہ براؤزر سیشن یہ API کال نہیں کر سکتا، اور اسسٹنٹ ایپس کی کلیدیں الگ ہیں: دیکھیں اسسٹنٹ ایپ جوڑیں۔