مواد پر جائیں
14 دن کا مفت ٹرائل، کارڈ کی ضرورت نہیں9 زبانیں176 کاروباری اقسام · 50 ایپس
UR· USD
لائیو ڈیمو آزمائیںمفت آزمائش شروع کریں

انٹیگریشنز اور REST API: یہ کیسے کام کرتا ہے

انٹیگریشنز اور API دوسرے سافٹ ویئر کو آپ کے ڈیٹا کے ساتھ کام کرنے دیتے ہیں۔ API کلید کے ذریعے کوئی دوسرا سسٹم کسٹمرز، لیڈز، کوٹیشنز، انوائسز، آرڈرز اور پروڈکٹس پڑھ سکتا ہے اور ان میں سے کچھ بنا بھی سکتا ہے، جبکہ ویب ہُکس دوسرے سسٹم کو فوراً بتا دیتے ہیں کہ یہاں کچھ ہوا ہے۔ اسے اکاؤنٹنگ ٹولز، آٹومیشن سروسز یا اپنی ایپ جوڑنے کے لیے استعمال کریں۔

سبق 2 از 9 · یہ کیسے کام کرتا ہے

  • تقریباً 3 منٹ
  • System → Integrations → Integrations & API

یہ کیسے کام کرتا ہے

  1. «System → Integrations → Integrations & API» کے اوپر چار ہندسے نظر آتے ہیں: «Active keys»، «Endpoints»، «Delivered (7 d)» اور «Failed»۔ ان کے نیچے «API keys»، «Webhook endpoints» اور «Event catalog» کے پینل ہیں۔

  2. «Create key» دبائیں، اسے ایسا نام دیں جو بتائے کہ یہ کہاں استعمال ہوتی ہے، اس کے اسکوپس پر نشان لگائیں اور چاہیں تو میعاد ختم ہونے کی تاریخ دیں۔ اسکوپ کسی ایک قسم کے ریکارڈ کو پڑھنے یا لکھنے کا حق ہے۔ لکھنے کے حق میں پڑھنا بھی شامل ہے۔

  3. نئی کلید صرف ایک بار «Your new API key» کے نیچے دکھائی جاتی ہے۔ اسے فوراً کاپی کر لیں: صرف اس کا فنگر پرنٹ محفوظ ہوتا ہے، اس لیے یہ دوبارہ نہیں دکھائی جا سکتی۔

  4. دوسرا سسٹم ہر درخواست کے ساتھ یہ کلید بھیجتا ہے۔ وہ کسٹمرز، لیڈز، کوٹیشنز، انوائسز، آرڈرز اور پروڈکٹس کی فہرست دیکھ اور پڑھ سکتا ہے، اور کسٹمرز، لیڈز، ڈرافٹ کوٹیشنز اور ڈرافٹ انوائسز بنا سکتا ہے۔

  5. API کے ذریعے بنائی گئی لیڈ وہی پیغامات چلاتی ہے جو ویب سائٹ کا فارم چلاتا ہے۔ API سے بنی کوٹیشنز اور انوائسز ہمیشہ ڈرافٹ ہوتی ہیں اور ان کا ٹیکس ویسے ہی لگتا ہے جیسے ایڈمن ایڈیٹر میں۔ API انہیں کبھی بھیجتا نہیں اور نہ ادا شدہ نشان زد کرتا ہے۔

  6. ہر کلید کی قطار میں اس کے اسکوپس، اسے بنانے والا، درخواستوں کی تعداد اور آخری استعمال نظر آتا ہے، ساتھ «Active»، «Expired» یا «Revoked» کا بیج ہوتا ہے۔ «Revoke» کلید کو فوراً بند کر دیتا ہے۔

  7. «API docs» ڈویلپر کے لیے مکمل حوالہ کھولتا ہے، اور «Delivery log» ویب ہُک پوسٹس کی فہرست کھولتا ہے۔

یہ کہاں ملے گا

سیٹنگز جو اسے بدلتی ہیں

چیک لسٹ

آگے بڑھنے سے پہلے دیکھ لیں کہ آپ یہ کر سکتے ہیں:

  • System → Integrations → Integrations & API کھولیں
  • System → Integrations → Integrations & API کے اوپر چار ہندسے نظر آتے ہیں: Active keys، Endpoints، Delivered…
  • Create key دبائیں، اسے ایسا نام دیں جو بتائے کہ یہ کہاں استعمال ہوتی ہے، اس کے اسکوپس پر نشان لگائیں اور…
  • نئی کلید صرف ایک بار Your new API key کے نیچے دکھائی جاتی ہے۔
  • دوسرا سسٹم ہر درخواست کے ساتھ یہ کلید بھیجتا ہے۔

مشورے اور عام غلطیاں

  • کلید گم ہو گئی؟ اسے واپس حاصل نہیں کیا جا سکتا۔ پرانی کلید منسوخ کریں اور نئی بنائیں۔
  • اگر کوئی درخواست کسی اسکوپ کی کمی کی وجہ سے رد ہو تو اس کا مطلب ہے کہ کلید اس حق کے بغیر بنائی گئی تھی۔ اس اسکوپ پر نشان لگا کر نئی کلید بنائیں۔
  • ایک کلید ایک ساتھ 300 درخواستیں کر سکتی ہے اور اس کے بعد فی سیکنڈ 5۔ اس سے تیز مانگنے والے سسٹم کو انتظار کرنے کو کہا جاتا ہے، اور ایک ہی ایڈریس سے بار بار رد ہونے پر عارضی پابندی لگ سکتی ہے۔
  • کلید کو پاس ورڈ کی طرح سنبھالیں۔ ہر جڑے ہوئے سسٹم کو اس کی اپنی کلید دیں، تاکہ آپ دوسروں کو روکے بغیر ایک کو منسوخ کر سکیں۔