انتقل إلى المحتوى الرئيسي
Phynxa

مفاتيح API

أنشئ مفاتيح API للمطوّرين واسحبها، وأرسلها إلى API، واعرف ما يستطيع المفتاح الوصول إليه وما لا يستطيعه.

ما الذي ستحققه

سيكون لديك مفتاح يتيح لشيفرتك استخدام مساحة عملك.

المتطلبات المسبقة

  • دور owner أو admin.

الإعداد خطوة بخطوة

  1. افتح Settings وتبويب Profile & Account، وابحث عن Developer API Keys ("Keys for connecting your own apps to Phynxa").
  2. اختر Create API Key (أو Create your first key).
  3. أدخل Key Name، مثل "Zapier Integration" أو "Production CRM"، واختر Generate Key.
  4. يظهر Important Secret Notice: "This key will not be shown again, so store it somewhere safe." اختر Copy Key واحفظه، ثم Done.

استخدام المفتاح

أرسله كرمز Bearer:

bash
curl https://phynxa.com/api/agents \
  -H "Authorization: Bearer nxa_live_YOUR_KEY"

يبدو المفتاح هكذا: nxa_live_ يتبعه 40 حرفًا. وتعرض القائمة في Settings آخر أربعة أحرف منه فقط، وتاريخ Created ووقت Last Used.

ما الذي يستطيع المفتاح الوصول إليه

يعمل المفتاح بصفة مسؤول في مساحة العمل التي أُنشئ فيها، وفي هذه الأجزاء فقط من API:

agents وcalls وcontacts وcampaigns وtools وknowledge وwebhooks وforms وcaptures وscheduled-calls وstats وinsights.

وهو لا يستطيع الوصول إلى settings أو team أو billing أو حسابك أو التكاملات أو مفاتيح أخرى. والطلب إلى هذه المسارات بمفتاح يُردّ عليه بـ 401 Sign in to continue.

الحدود

  • 600 طلب في الدقيقة لكل مفتاح. وبعد ذلك تتلقى 429 مع "Rate limit reached for this key."
  • تُحتسَب المكالمات المُجراة عبر API ضمن سقوف الاتصال في الساعة (20 لكل شخص و200 لكل مساحة عمل).

سحب مفتاح

في القائمة اختر Revoke على المفتاح وأكّد ("Revoke Developer API Key"). يتوقف عن العمل فورًا. افعل ذلك إذا كان من الممكن أن يكون مفتاح قد تسرّب.

الاستخدام

يعرض تبويب API Usage في Settings Total API Requests وActive API Keys وTools & Actions Used وAPI Success Rate، وتفصيلًا لكل أداة ونقطة اتصال، والنشاط الأخير.

الاختبار

استدعِ GET /api/agents بمفتاحك. ينبغي أن تتلقى قائمة JSON بوكلائك. ثم تحقق من أن Last Used يتحدث في Settings.

النتيجة المتوقعة

200 مع وكلائك. ومع مفتاح خاطئ أو مسحوب: 401 {"detail":"Sign in to continue."}.

استكشاف الأخطاء

  • 401 مع مفتاح صحيح. المسار ليس مما يجوز لمفتاح استخدامه، أو سُحب المفتاح.
  • فقدت المفتاح. لا يمكن عرضه مجددًا. أنشئ مفتاحًا جديدًا واسحب القديم.

الأمان وبيانات الاعتماد

تعامل مع المفتاح كأنه كلمة مرور: لا تضعه في تطبيق متصفح أو مستودع عام. واستخدم مفتاحًا لكل تكامل لتتمكن من سحب واحد دون كسر الباقي.

أدلة ذات صلة

هل في هذه الصفحة ما لا يطابق ما تراه في لوحة التحكم؟ أخبرنا.