استخدام Ody API وحزم SDK
تتضمن كل خطة Ody واجهة REST API العامة. أنشئ مفتاحًا في التطبيق، ثم استدعِ API مباشرة أو ثبّت حزمة SDK رسمية. المرجع الكامل والأدلة والأمثلة موجودة على موقع المطور — dev.ody.co — وليس في مركز المساعدة هذا.
إنشاء مفتاح API
يجب أن تكون مسؤول مساحة عمل أو المالك.
- افتح الإعدادات ← Developer API (على الهاتف: المزيد ← الإعدادات ← Developer API).
- اكتب اسم المفتاح (على سبيل المثال "Zapier" أو "خادم الإنتاج").
- اترك كل النطاقات محددة للوصول الكامل، أو ألغِ تحديد النطاقات لتقييد المفتاح (على سبيل المثال مفتاح للقراءة فقط لمساعد AI).
- ضمن نوع المفتاح، اختر Live أو Test.
- انقر على إنشاء مفتاح.
- انسخ السر من اللافتة "انسخ مفتاحك الجديد الآن — لن تراه مرة أخرى." يخزن Ody تجزئة فقط — إذا فقدت السر، قم بإلغاء المفتاح وإنشاء مفتاح جديد.
تعرض قائمة المفاتيح تلميحًا مقنعًا (ody_live_…WXYZ أو ody_test_…WXYZ)، وشارة Test لمفاتيح الاختبار، والنطاقات، ومتى تم استخدام المفتاح آخر مرة. انقر على إلغاء لتعطيل المفتاح فورًا.
تثبيت حزمة SDK
تغلف العملاء الرسميون بدون تبعيات نفس REST API، مع ترقيم الصفحات التلقائي، والأخطاء المكتوبة، والإرسالات المتكررة، والتحقق من Standard Webhooks:
| اللغة | التثبيت | الوثائق |
|---|---|---|
| TypeScript / JavaScript | npm install @ody-co/sdk |
dev.ody.co/sdks/typescript |
| Python | pip install ody-sdk (استيراد باسم ody) |
dev.ody.co/sdks/python |
ابدأ بـ نظرة عامة على SDK أو البدء السريع في 5 دقائق. هل تفضل HTTP العادي؟ كل مثال على موقع المطور يحتوي على علامة تبويب cURL، ومواصفات OpenAPI القابلة للقراءة آليًا موجودة على api.ody.co/v1/api/openapi.json.
ماذا يوجد أيضًا على موقع المطور
| الموضوع | الرابط |
|---|---|
| المصادقة، النطاقات، Live مقابل Test | المصادقة |
| مرجع REST API | نظرة عامة على API |
| Webhooks الصادرة (التحقق من التوقيعات، كتالوج الأحداث) | Webhooks |
| ربط ChatGPT أو Claude عبر MCP | MCP |
| Switchboard (تخطيط وبناء توجيه المكالمات باستخدام AI) | Switchboard |
نفس مفتاح API يشغل REST، وحزم SDK، وخادم MCP. الصق مفتاحًا في عميل MCP مع نقطة النهاية الموضحة ضمن الاتصال بـ ChatGPT و Claude على شاشة Developer API.
استكشاف الأخطاء وإصلاحها
- "تعذر إنشاء مفتاح API" — يجب أن تكون مسؤولاً أو مالكًا لمساحة العمل. اطلب من المالك ترقيتك، أو اطلب منه إنشاء المفتاح.
- فقدان السر — لا يمكنك استعادته. قم بإلغاء المفتاح في الإعدادات ← Developer API وأنشئ مفتاحًا جديدًا.
- 401 / غير مصرح به من التعليمات البرمجية الخاصة بك — تحقق مما إذا كان المفتاح Live أم Test كما قصدت، وأنه لم يتم إلغاؤه، وأن رأس
Authorization: Bearer …يستخدم السر الكامل (بما في ذلك البادئةody_live_أوody_test_). - 403 نطاق مفقود — تم إنشاء المفتاح بمجموعة محدودة من النطاقات. أنشئ مفتاحًا جديدًا بالنطاقات التي تحتاجها نقطة النهاية الخاصة بك، أو راجع النطاقات.
- تريد Zapier / Make بدلاً من التعليمات البرمجية — العديد من أدوات no-code تستدعي REST API بنفس المفتاح؛ راجع نظرة عامة على API. توجد اتصالات CRM ومكتب المساعدة المدمجة ضمن ما هي التكاملات التي يدعمها Ody؟.
مقالات ذات صلة
الأسئلة الشائعة
أين توجد وثائق المطور؟
كل ما يحتاجه المطورون موجود على https://dev.ody.co — REST API، webhooks، MCP، Switchboard، وحزم SDK لـ TypeScript و Python. يغطي مركز المساعدة فقط كيفية إنشاء مفتاح API الخاص بك في التطبيق.
كيف أقوم بتثبيت Ody SDK؟
TypeScript/JavaScript: npm install @ody-co/sdk. Python: pip install ody-sdk (استيراد باسم ody). كلاهما في الإصدار v0.6.0، بدون تبعيات، ويتضمنان التحقق من webhooks.
من يمكنه إنشاء مفتاح API؟
مسؤول مساحة العمل أو المالك. افتح **الإعدادات** ← **Developer API** (على الهاتف: **المزيد** ← **الإعدادات** ← **Developer API**).
ما الفرق بين مفاتيح Live و Test؟
مفاتيح Live (ody_live_…) ترسل رسائل نصية حقيقية وتجري مكالمات حقيقية. مفاتيح Test (ody_test_…) تقرأ وتكتب بيانات مساحة العمل الحقيقية ولكنها لا ترسل رسائل نصية حقيقية أبدًا — يتم تسجيل الإرسالات على أنها محاكاة. استخدم Test أثناء البناء.