API تک رسائی (ڈویلپرز کے لیے)
ایجنسی اور انٹرپرائز پلانز میں، سیٹنگز > انٹیگریشنز کے تحت پبلک API کے لیے صرف پڑھنے والی یا پڑھنے + لکھنے والی کلیدیں بنائیں؛ جب پلان میں API تک رسائی شامل نہ رہے تو کلیدیں روک دی جاتی ہیں۔
سیٹنگز → انٹیگریشنز (/app/settings/integrations)، صفحے کے نیچے کارڈ API تک رسائی (ڈویلپرز کے لیے)۔ صرف مالکان اور ایڈمنز کے لیے۔ "پوسٹس بنانے، رابطے شامل کرنے یا اینالیٹکس خودکار طور پر پڑھنے کے لیے OmniBrand کو اپنے سسٹمز، Zapier یا Make سے جوڑیں۔" کلید آپ کے اپنے سافٹ ویئر کو ہیڈر Authorization: Bearer ob_live_… کے ساتھ OmniBrand پبلک API کو کال کرنے دیتی ہے۔ کارڈ کے نیچے API اینڈ پوائنٹ وہ ایڈریس دکھاتا ہے جس پر یہ درخواستیں بھیجنی ہیں ("وہ ایڈریس جس پر پبلک API جواب دیتا ہے۔ ہر درخواست وہاں بھیجیں، اوپر دی گئی کلیدوں میں سے ایک کے ساتھ۔")۔ /app/settings#developer کے پرانے لنکس یہی کارڈ کھولتے ہیں۔
کن پلانز میں شامل ہے
API تک رسائی ایجنسی اور انٹرپرائز پلانز کا حصہ ہے۔ فری، اسٹارٹر اور پرو پر، اور 14 دن کے پرو ٹرائل کے دوران، کارڈ صرف "API تک رسائی ایجنسی پلان میں دستیاب ہے۔" اور پلان اور استعمال کا پلانز دیکھیں لنک دکھاتا ہے؛ کلید بنانے کا فارم نہیں ہوتا۔ پلان اور استعمال اور /pricing پر پلان کارڈز ایجنسی اور انٹرپرائز کے لیے API تک رسائی دکھاتے ہیں۔
جب پلان بدلتا ہے
- جب اکاؤنٹ ایسے پلان پر جاتا ہے جس میں API تک رسائی نہیں (ڈاؤن گریڈ، ریفنڈ یا کسی ٹرائل کا اختتام)، تو اس کی کلیدیں روک دی جاتی ہیں: وہ محفوظ رہتی ہیں اور کچھ حذف نہیں ہوتا، لیکن ان سے کی گئی ہر کال "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." کے ساتھ مسترد ہوتی ہے (HTTP 403، کوڈ
api_access_not_in_plan)۔ - اکاؤنٹ کے مالک کو پلانز دیکھیں بٹن کے ساتھ ایک ہی ای میل ملتی ہے: Your API keys are paused ("آپ کی API کلیدیں روک دی گئی ہیں کیونکہ آپ کے پلان میں اب API تک رسائی شامل نہیں…")۔
- ایجنسی یا انٹرپرائز پر واپس جانے سے وہی کلیدیں ایک منٹ کے اندر دوبارہ چل پڑتی ہیں۔ نئی کلیدیں بنانے کی ضرورت نہیں۔
- رکی رہنے کے دوران کلیدیں فہرست میں نہیں دکھتیں اور نہ بنائی جا سکتی ہیں نہ روٹیٹ کی جا سکتی ہیں۔ کسی کلید کو مستقل طور پر بند کرنے کے لیے API تک رسائی والے پلان پر واپس جائیں اور اس پر منسوخ کریں پر کلک کریں، یا سپورٹ سے رابطہ کریں۔
مرحلہ وار: کلید بنائیں
- کلید کا نام (مثلا CI bot) میں نام ٹائپ کریں، 60 حروف تک، تاکہ بعد میں معلوم ہو کہ اسے کیا استعمال کرتا ہے۔ بغیر نام (یا صرف اسپیسز) کے، کلید بنائیں کچھ نہیں بناتا اور باکس پر لکھا ہوتا ہے "Key کو ایک نام دیں، مثلا "Website sync"۔" نام سے پہلے اور بعد کی جگہیں ہٹا دی جاتی ہیں۔
- کلید کے دائرہ کار میں، صرف پڑھنا (ڈیٹا پڑھنا) یا پڑھنا + لکھنا (چیزیں بنانا اور تبدیل کرنا) منتخب کریں۔
- کلید بنائیں پر کلک کریں۔
- ایک پیلا باکس دکھاتا ہے ""(name)" کے لیے نئی کلید۔ ابھی کاپی کریں: یہ صرف ایک بار دکھائی دیتا ہے۔" اور مکمل چابی، کاپی کریں (پھر کہتا ہے کاپی ہو گیا) اور میں نے اسے محفوظ کر لیا ہے، جس سے باکس بند ہو جاتا ہے۔ ابھی کی کاپی کریں اور اسے محفوظ جگہ پر رکھیں؛ OmniBrand صرف فنگر پرنٹ محفوظ کرتا ہے اور اسے دوبارہ کبھی نہیں دکھا سکتا۔
فہرست
ہر کلید اپنا نام، ابتدائی حروف (ob_live_…)، اپنا دائرہ، آخری بار کب استعمال ہوئی ("استعمال ہوئی ..." یا "کبھی استعمال نہیں ہوئی") اور اپنی آخری تاریخ کے ساتھ "میعاد ختم ..." دکھاتی ہے۔
- روٹیٹ کریں: پہلے پوچھتا ہے: ""(نام)" (سابقہ…) کو روٹیٹ کریں؟ آپ کو فوراً نئی کلید مل جاتی ہے۔ موجودہ کلید 24 گھنٹے تک کام کرتی رہتی ہے اور پھر بند ہو جاتی ہے، اس لیے اس سے پہلے نئی کلید ہر اس جگہ لگا دیں جہاں پرانی استعمال ہو رہی ہے۔" آگے بڑھنے کے لیے کلید روٹیٹ کریں پر کلک کریں، یا منسوخ کریں۔ اسی نام اور دائرہ کار والی نئی کلید اسی پیلے خانے میں ایک بار دکھائی جاتی ہے۔ پرانی کلید 24 گھنٹے تک کام کرتی رہتی ہے تاکہ آپ اپنی انٹیگریشن نئی کلید پر منتقل کر سکیں، پھر بند ہو جاتی ہے۔ تب تک وہ فہرست میں رہتی ہے، کٹی ہوئی نہیں، "پرانی کلید [تاریخ اور وقت] تک کام کرے گی" اور منسوخ کریں بٹن کے ساتھ۔
- منسوخ کریں: پوچھتا ہے "کلید (name) (prefix…) منسوخ کریں؟ اسے استعمال کرنے والی ہر چیز فوراً کام کرنا بند کر دے گی، اور منسوخ شدہ کلید دوبارہ آن نہیں کی جا سکتی۔" ونڈو کا عنوان کلید منسوخ کریں؟ ہے؛ کلید فوراً روکنے کے لیے کلید منسوخ کریں پر کلک کریں، یا اسے رکھنے کے لیے منسوخ کریں۔ یہ روٹیشن کے بعد اس کے 24 گھنٹوں کے دوران پرانی کلید پر بھی کام کرتا ہے: اگر آپ نے کلید لیک ہونے کی وجہ سے روٹیٹ کی تو پرانی کلید پر منسوخ کریں پر کلک کریں تاکہ یہ ابھی بند ہو جائے۔ منسوخ شدہ کلیدیں (اور روٹیٹ شدہ کلیدیں ان کے 24 گھنٹے پورے ہونے کے بعد) فہرست میں کٹی ہوئی رہتی ہیں، نام کے نیچے سرخ "(date) کو منسوخ کی گئی" لیبل کے ساتھ۔
کلید کا مالک کون ہے
- کلید اس شخص کی ہوتی ہے جس نے اسے بنایا، اور یہ ان ورک اسپیسز کا احاطہ کرتی ہے جہاں بناتے وقت وہ شخص مالک یا ایڈمن تھا۔
- یہ صرف اسی وقت تک کام کرتی ہے جب تک اس کا بنانے والا ان تمام ورک اسپیسز کا فعال مالک یا ایڈمن رہے جن کا یہ احاطہ کرتی ہے۔ اگر اسے ہٹا دیا جائے، اس کا درجہ کم کر دیا جائے یا اس کا لاگ اِن غیر فعال کر دیا جائے تو کالز اس پیغام کے ساتھ ناکام ہوتی ہیں: "جس شخص نے یہ API کلید بنائی تھی وہ اب اس کے ورک اسپیسز کا ایڈمن نہیں ہے۔ کسی موجودہ ایڈمن سے نئی کلید جاری کرنے کو کہیں۔"
- آپ صرف وہی کلیدیں دیکھ، روٹیٹ اور منسوخ کر سکتے ہیں جن کے ورک اسپیسز کے آپ خود ایڈمن ہیں۔ بہت سے کلائنٹ ورک اسپیسز والے اکاؤنٹ میں ایک کلائنٹ کا ایڈمن دوسرے کلائنٹ کی کلیدیں نہیں دیکھ سکتا۔
اگر کچھ غلط ہو جائے
- "This API key has expired. Rotate it under Settings > Integrations > API access.": کلیدیں ایک سال چلتی ہیں۔ API تک رسائی (ڈویلپرز کے لیے) میں اس کلید پر روٹیٹ کریں پر کلک کریں (یا نئی بنائیں) اور اپنا انٹیگریشن اپ ڈیٹ کریں۔
- "غلط یا منسوخ شدہ API کلید": کلید منسوخ کر دی گئی، روٹیشن کی 24 گھنٹے کی مہلت ختم ہو گئی، یا یہ ادھوری کاپی ہوئی۔
- API کلید دوسری کلیدیں نہ بنا سکتی ہے، نہ روٹیٹ کر سکتی ہے نہ منسوخ؛ یہ صرف سائن اِن کیا ہوا شخص کر سکتا ہے۔
- "یہ اینڈ پوائنٹ API کلیدوں کے لیے دستیاب نہیں ہے": یہ کال صرف سائن ان شخص کے لیے ہے، کلید کا دائرہ کار کچھ بھی ہو۔ کوئی کلید کبھی ان تک نہیں پہنچ سکتی: ارکان اور دعوت نامے (
/workspaces/{id}/members،/workspaces/{id}/invitations،/invitations)، ورک اسپیس بنانا، نام بدلنا، آرکائیو کرنا، آرکائیو سے نکالنا یا حذف کرنا، آؤٹ باؤنڈ ویب ہکس (/workspaces/{id}/webhooks)، ایکسپورٹس، منظوری کی چین، رپورٹ شیڈولز، چینل منسلک، منقطع یا ہٹانا یا اس کا مالک بدلنا، تنظیم کا لوگو، پروفائل اور آن بورڈنگ، اور /auth، /billing، /admin یا /tenant/api-keys کے تحت کچھ بھی۔ یہ کام ایپ میں، مالک یا ایڈمن کے طور پر لاگ ان ہو کر کریں۔ کلید کے ذریعے AI میں پوسٹ کا متن، آئیڈیاز، تصاویر، دوبارہ لکھنا، ہیش ٹیگز، متبادل متن اور پیغامات کی چھانٹی شامل ہے، فی کلید ایک منٹ میں 10 اور ایک دن میں 300 کالز تک ("API key AI rate limit exceeded")؛ ویڈیو، AI Studio اور باقی AI مددگار صرف سائن اِن لوگوں کے لیے ہیں۔ Market Watch کے کام، ذرائع اور ترتیبات، bots، اور auto-triage جیسی workspace ترتیبات بھی صرف سائن اِن شخص ہی بدل سکتا ہے۔ سپورٹ آن یا آف کرنے، اس کی AI درجہ بندی بدلنے اور Brand Health کی AI تشریح کے لیے بھی سائن اِن شخص درکار ہے، اور key سے مانگی گئی رپورٹ میں AI خلاصہ تبھی ہوتا ہے جب وہ پہلے سے موجود ہو۔