ڈویلپرز کے لیے

آپ کے سسٹم کے اندر Cyzyra. اور Cyzyra کے اندر آپ کے سسٹمز۔

REST API، دستخط شدہ ویب ہکس اور AI معاونین سے کنکشن۔ کمپنی کا ڈیٹا ERP، BI یا آپ کی اپنی درخواست پر لے جانے کے لیے۔

curl https://YOUR-PAINEL/api/v1/leads?limit=20 \ -H "تصدیق: بیئرر cy_live_..."

{ "ڈیٹا": [{ "id": "…", "name": "…", "status": "new" }], "next_cursor": null }

کال اور جواب کی مثالی مثال۔

01 / انضمام کے تین طریقے

پڑھیں، وصول کریں اور پوچھیں۔

ایک، دو یا تینوں کا استعمال کریں۔ وہ سبھی کلید کی اجازتوں اور اس کی ملکیت والی کمپنی کے ڈیٹا کا احترام کرتے ہیں۔

REST API
OpenAPI دستاویزات کے ساتھ JSON میں لیڈز، مذاکرات، ادائیگیاں، اشیاء اور میٹرکس۔
ویب ہکس
18 کمپنی کے واقعات سبسکرپشن کے ساتھ فوری طور پر آپ کے سسٹم پر بھیجے گئے۔
AI معاونین (MCP)
Cyzyra کو MCP سے مطابقت رکھنے والے AI معاونین سے مربوط کریں اور سیلز، اشتہارات اور منافع کے بارے میں پوچھیں۔

02 / REST API

اینڈ پوائنٹس

کی طرف سے تصدیق اجازت: بردار, ، JSON جوابات اور کرسر صفحہ بندی۔

120 درخواستیں فی منٹ فی کلید
کلید صرف ایک ہیش کے طور پر محفوظ کی جاتی ہے۔

GET/api/v1/leadsلیڈز کی فہرست بنائیں اور تلاش کریں۔
POST/api/v1/leadsایک لیڈ بنائیں (ڈپلیکیٹ چیکنگ کے ساتھ)
GET/api/v1/leads/{id}تفصیلات کے ساتھ ایک لیڈ
PATCH/api/v1/leads/{id}لیڈ کو اپ ڈیٹ کریں۔
GET/api/v1/dealsمذاکرات اور فنل کے مراحل
POST/api/v1/dealsایک تجارت بنائیں
GET/api/v1/paymentsبلنگ اور ادائیگیاں
GET/api/v1/objectsآپ کے آبجیکٹ کی اقسام
GET/api/v1/objects/{type}/recordsآبجیکٹ کی قسم کے ریکارڈز
POST/api/v1/objects/{type}/recordsریکارڈ بنائیں
POST/api/v1/queryفلٹرز اور پیریڈز کے ساتھ میٹرکس
POST/api/v1/askڈیٹا کے بارے میں پرتگالی میں سوال

03 / ویب ہکس

یہ کمپنی میں ہوا، یہ آپ کے سسٹم میں آگیا۔

واقعات اور پتہ کا انتخاب کریں۔ ہر جمع کرانے پر دستخط کیے جاتے ہیں، اور جو ناکام ہو جاتا ہے اسے 5 بار تک بھیج دیا جاتا ہے۔

HMAC دستخط وقت کے ساتھ، دوبارہ بھیجنے کے خلاف
ڈیش بورڈ پر ہر کوشش کی تاریخ

// Cabeçalho: X-Cyzyra-Signature: t=1731000000,v1=<hmac>
const [t, v1] = header.split(",").map((p) => p.split("=")[1]);
const esperado = hmacSha256(segredo, `${t}.${corpoBruto}`);
if (esperado !== v1) throw new Error("assinatura inválida");

18 دستیاب واقعات

Lead criadolead.created
Status do lead mudoulead.status_changed
Cadastros unificadoslead.merged
Negociação criadadeal.created
Negociação mudou de etapadeal.stage_changed
Venda ganhadeal.won
Venda perdidadeal.lost
تجویز بھیج دی گئی۔proposal.sent
تجویز منظور کر لی گئی۔proposal.accepted
Proposta recusadaproposal.rejected
معاہدہ بھیجا گیا۔contract.sent
Contrato assinadocontract.signed
چارج بنایا گیا۔payment.created
Pagamento recebidopayment.paid
Pagamento falhoupayment.failed
Pagamento estornadopayment.refunded
Ordem de serviço criadawork_order.created
Mensagem recebidamessage.received

04 / AI معاونین

اپنے اسسٹنٹ کے اندر سے Cyzyra سے پوچھیں۔

اپنی API کلید کے ساتھ مطابقت پذیر AI اسسٹنٹ میں Cyzyra کے MCP ایڈریس کو حسب ضرورت کنیکٹر کے طور پر شامل کریں۔ وہ منافع، مہمات اور فروخت سے متعلق مشاورت شروع کرتا ہے، اور اپنے ڈیٹا کے بارے میں پرتگالی میں سوالات کے جوابات دیتا ہے۔

URL: https://SEU-PAINEL/api/mcp ہیڈر: اجازت: بیئرر cy_live_... ٹولز: خلاصہ_منافع · مہمات · سیلز پوچھیں · انتظام_کیمپینز (تحریر)

05 / سوالات

تکنیکی سوالات

ریڈی میڈ انٹیگریشنز دیکھیں

میں API کلید کہاں بناؤں؟+

API پلیٹ فارم ڈیش بورڈ میں (مینو سسٹم → API پلیٹ فارم → API کیز)۔ کلید صرف ایک بار ظاہر ہوتی ہے۔ Cyzyra صرف اس کا ایک انکرپٹڈ ورژن رکھتا ہے۔

کلید کو کیا اجازت مل سکتی ہے؟+

پڑھنا، یا پڑھنا اور لکھنا۔ MCP کنکشن پر لیڈز بنانے یا مہمات کو تبدیل کرنے جیسی کارروائیوں کے لیے تحریری اجازت درکار ہوتی ہے۔

کیا استعمال کی کوئی حد ہے؟+

ہاں: 120 درخواستیں فی منٹ فی کلید۔ اس کے اوپر، API 429 جواب دیتا ہے اور آپ کو بتاتا ہے کہ کتنے سیکنڈ میں دوبارہ کوشش کرنی ہے۔

اگر ویب ہک باہر جانے پر میرا سسٹم ڈاؤن ہو تو کیا ہوگا؟+

Cyzyra بڑھتے ہوئے وقفوں کے ساتھ، 5 بار تک دوبارہ کوشش کرتا ہے، اور ہر کوشش کو ڈیش بورڈ پر دکھاتا ہے۔

ہر کلید کس کا ڈیٹا دیکھتی ہے؟+

صرف اس کمپنی سے جس نے کلید بنائی۔ دوسری کمپنیوں کا ڈیٹا کبھی ظاہر نہیں ہوتا ہے۔

اپنا اکاؤنٹ بنائیں اور آج ہی اپنی پہلی کلید بنائیں۔

کے لیے پہلا مہینہ US$ 10,00, مکمل رسائی کے ساتھ۔ پھر، آپ منصوبہ منتخب کرتے ہیں.

کے لیے شروع کریں۔ US$ 10,00

ایک شخص سے بات کرنے کو ترجیح دیتے ہیں؟ ٹیم سے بات کریں۔

منسوخ کرنے کے لیے کوئی جرمانہ نہیں ہے · گارنٹی 30 dias

مثالی مثال