برای توسعه دهندگان

Cyzyra در سیستم های شما. و سیستم های شما در Cyzyra.

REST API، وب هوک های امضا شده و اتصال به دستیاران هوش مصنوعی. برای انتقال داده های شرکت به ERP، BI یا برنامه شخصی خود.

مستندات را بخوانید پلتفرم API را باز کنید

curl https://YOUR-PAINEL/api/v1/leads?limit=20 \ -H "Authorization: Bearer cy_live_..."

{ "داده": [{ "id": "..."، "نام": "..."، "وضعیت": "جدید" }]، "next_cursor": null }

مثال گویا تماس و پاسخ.

01 / سه راه برای ادغام

بخوانید، دریافت کنید و بپرسید.

از یک، دو یا هر سه استفاده کنید. همه آنها به مجوزهای کلید و داده های شرکت صاحب آن احترام می گذارند.

REST API
سرنخ ها، مذاکرات، پرداخت ها، اشیاء و معیارها در JSON، با اسناد OpenAPI.
وب هوک ها
رویدادهای شرکت 18 فوراً و با اشتراک به سیستم شما ارسال می شوند.
دستیاران هوش مصنوعی (MCP)
Cyzyra را به دستیارهای هوش مصنوعی سازگار با MCP متصل کنید و در مورد فروش، تبلیغات و سود بپرسید.

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 / دستیاران هوش مصنوعی

از Cyzyra از داخل دستیار خود بپرسید.

آدرس MCP Cyzyra را به عنوان یک رابط سفارشی در یک دستیار هوش مصنوعی سازگار با کلید API خود اضافه کنید. او شروع به مشاوره در مورد سود، کمپین ها و فروش می کند و به پرسش هایی به زبان پرتغالی در مورد داده های خود پاسخ می دهد.

URL: https://SEU-PAINEL/api/mcp سربرگ: مجوز: حامل cy_live_... ابزارها: خلاصه_سود · کمپین ها · درخواست فروش · مدیریت_کمپین ها (نوشتن)

05 / سوالات

سوالات فنی

مشاهده ادغام های آماده

از کجا کلید API را ایجاد کنم؟+

در داشبورد API Platform (منوی System → API Platform → API Keys). کلید فقط یک بار ظاهر می شود. Cyzyra فقط یک نسخه رمزگذاری شده از آن را نگه می دارد.

یک کلید چه مجوزهایی می تواند داشته باشد؟+

خواندن، یا خواندن و نوشتن. اقداماتی مانند ایجاد سرنخ یا تغییر کمپین از طریق اتصال MCP نیاز به مجوز نوشتن دارد.

Existe limite de uso?+

بله: 120 درخواست در دقیقه برای هر کلید. بالاتر از آن، API به 429 پاسخ می دهد و به شما می گوید چند ثانیه دوباره امتحان کنید.

اگر زمانی که یک وب هوک از کار بیفتد، سیستم من از کار بیفتد؟+

Cyzyra تا 5 بار با افزایش فواصل مجدد تلاش می کند و هر تلاش را روی داشبورد نمایش می دهد.

هر کلید داده های چه کسانی را می بیند؟+

فقط از شرکتی که کلید را ایجاد کرده است. داده های سایر شرکت ها هرگز ظاهر نمی شوند.

حساب کاربری خود را ایجاد کنید و اولین کلید خود را امروز ایجاد کنید.

ماه اول برای US$ 10,00, ، با دسترسی کامل سپس، شما طرح را انتخاب می کنید.

شروع برای US$ 10,00

ترجیح می دهید با یک نفر صحبت کنید؟ با تیم صحبت کنید

هیچ جریمه ای برای لغو وجود ندارد · گارانتی 30 dias

مثال گویا