للذكاء الاصطناعي
كل ما يحتاجه مساعد البرمجة الذكي لبناء تكامل مع Crisphive — موجّه جاهز للّصق، وموارد قابلة للقراءة آليًا، وأهم حقائق واجهة البرمجة في مكان واحد.
التثبيت بالذكاء الاصطناعي
الصق هذا الموجّه في مساعد البرمجة الذكي الخاص بك لبدء التكامل:
Read the Crisphive backend integration skill at https://api.crisphive.com/developers/SKILL.md and the OpenAPI spec at https://api.crisphive.com/developers/openapi.json. Then implement a client for my backend that: 1. Authenticates with an API key as a Bearer token (chsk_test_… for sandbox) 2. Creates a customer and a job request 3. Keeps job requests in sync by polling GET /v1/job-requests/changes with the next_since cursor
تستخدم كل استجابة شكل غلاف واحد —
{ error_code, message, errors, data } — بحيث يمكن للعملاء المولَّدين مشاركة محلّل استجابات واحد.موارد قابلة للقراءة آليًا
يُقدَّم كلا الملفين من واجهة البرمجة نفسها، لذا يطابقان دائمًا النسخة المنشورة — وجِّه مساعدك إلى هذين الرابطين مباشرة بدلًا من نسخ صفحات التوثيق إلى سياقه.
| المورد | المحتوى |
|---|---|
SKILL.md | دليل تكامل مختصر مكتوب للوكلاء: المصادقة، وغلاف الاستجابة، وتدفقات الحجز الأساسية، والأخطاء الشائعة. |
openapi.json | مواصفة OpenAPI الكاملة — كل نقطة نهاية ومخططات الطلب/الاستجابة ورموز الأخطاء. استخدمها لتوليد عملاء بأنواع محددة. |
حقائق أساسية لمساعدك
- عنوان URL الأساسي هو
https://api.crisphive.com/v1— تتشارك بيئتا sandbox وlive المسارات نفسها؛ وتُحدَّد البيئة عبر بادئة المفتاح (chsk_test_…مقابلchsk_live_…). - صادِق على كل طلب عبر
Authorization: Bearer <api key>. تنتهي صلاحية المفاتيح — تُختار مدة الصلاحية عند الإنشاء (30 يومًا افتراضيًا، ومن 1 حتى 365) ولا يمكن تمديدها أبدًا؛ جدّد بإنشاء مفتاح بديل وإبطال المفتاح القديم (حتى 50 مفتاحًا نشطًا لكل بيئة). المفتاح المنتهي الصلاحية يُعيد401معAPI_KEY_EXPIRED، وهو مميّز عنAPI_KEY_INVALID. المفتاح إما أن يمنح صلاحية وصول كاملة أو يكون مقيّدًا بنطاقات أذونات محددة (مثل إنشاء طلبات العمل دون صلاحية قراءة قائمة عملائك)، وهو مرتبط دائمًا بمساحة عمل واحدة وبيئة واحدة (حيّة أو اختبارية). احتفظ بالمفاتيح في الخادم. - قيمة
error_codeتساوي0تعني النجاح؛ وأي قيمة أخرى خطأ، وتُدرج أخطاء التحقق تفاصيل كل حقل فيerrors. - انسخ البيانات عبر استدعاء
GET /v1/job-requests/changesبمؤشرnext_sinceالمُعاد بدلًا من إعادة سرد الموارد. - فضّل استخدام Webhooks لاستقبال الأحداث المدفوعة (الحجوزات والعملاء والفنيون) لحظة وقوعها؛ أمّا تدفق التغييرات فهو البديل القائم على السحب عندما يتعذّر عليك كشف نقطة نهاية.
نصائح لنتائج أفضل
- اجعل المساعد يقرأ
SKILL.mdأولًا — فهو صغير بما يكفي ليتّسع في السياق ويجيب عن معظم أسئلة التكامل دون المواصفة الكاملة. - ولِّد أنواع الطلب/الاستجابة من
openapi.jsonبدلًا من ترك النموذج يخمّن أسماء الحقول. - طوِّر باستخدام مفتاح sandbox (
chsk_test_…) ولا تنتقل إلى live إلا بعد نجاح التدفقات من البداية إلى النهاية. - عند تصحيح الأخطاء، تحقّق من
error_code— لا من حالة HTTP وحدها.