بيانات الاعتماد والبيئات#
طلبات AI API تستخدم مفتاح API تابع لحساب Ideal House API. حافظ عليه على خادمك وأرسله في رأس طلب APIKEY.
احصل على مفتاح API#
- سجّل الدخول إلى وحدة تحكم AI API.
- افتح عناصر تحكم مفتاح API واستحدث أو اختر المفتاح لتكاملك.
- احفظه في مدير الأسرار على خادمك أو في إعدادات البيئة. لا تحفظه في مستودع الشيفرة ولا تُضمّنه في حزمة المتصفح.
قراءة هذه الوثائق لا تنشئ مفتاح API ولا تمنح وصولاً إلى حساب.
كوّن بيئة الطلب#
استخدم الـ URL الأساسي ومسار الطلب المعلن في API المرجعي المختار. على سبيل المثال، المراجع التي تحدد https://api.ideal.house تستخدم ذلك المضيف الخاص بـ API، وليس URL الخاص بالوثائق.
احفظ مفتاح API في متغير بيئة حصري للخادم مثل IDEALHOUSE_API_KEY. هذا اسم متغير مثال لتطبيقك؛ وليس إعداد SDK. يجب أن يتضمن الطلب الرأس التالي، مع استبدال القيمة النائبة على خادمك:
APIKEY: YOUR_API_KEY
اتبع نوع المحتوى المطلوب لنقطة النهاية، والحقول، وتنسيق إدخال الصورة. للعمليات غير المتزامنة، احفظ معرف المهمة المعاد وإستخدم نقطة نهاية النتيجة الموثقة لتلك العملية.
التطوير والإنتاج#
شغّل اختبارات محلية عبر برنامجك الخلفي ليبقى المفتاح خاصًا. فعّل أسرار نشرك قبل النشر، والتحقّق من التسعير، وحدود المهام وخصم الاعتمادات. يمكن لطلبات الاختبار استخدام اعتمادات الحساب؛ لا تعدك هذه الأدلة بوجود بيئة اختبار مجانية منفصلة.
Shop ID وPublishable Key الخاصة بالتاجر وClient Secret Product Import ينتميان إلى تكامل Visualizer SDK. لا تغني عن مفتاح AI API. إعداد Allowed Origins (CORS) في لوحة تحكم التاجر خاص بتكامل Visualizer، وليس خطوة الإعداد لطلبات AI API على جانب الخادم.
تحقق من المصادقة#
اتبع البدء السريع، ثم افحص الرد الخاص بالعملية. إذا فشلت المصادقة، تحقق من رأس APIKEY واستشر رموز الأخطاء. احذف المفاتيح من السجلات ولقطات دعم العملاء.