نحن بصدد إنهاء API داخل المواقع. راجع مستند حالة إنهاء API داخل المواقع للحصول على التفاصيل، والتعرف على كيفية الترحيل إلى API السحابة من الجيل القادم.

إعدادات الملف الشخصي للنشاط التجاري

/v1/settings/business/profile

استخدم نقطة النهاية /v1/settings/business/profile لتكوين إعدادات الملف الشخصي للنشاط التجاري التالية: عنوان النشاط التجاري ووصف النشاط التجاري والبريد الإلكتروني للتواصل مع النشاط التجاري ومجال تخصص النشاط التجاري وموقع الويب الخاص بالنشاط التجاري.

قبل البدء

  • يجب أن تستخدم حساب admin للوصول إلى إعدادات الملف الشخصي للنشاط تجاري.

الاسترداد

يمكنك إجراء استدعاء واجهة API GET لاسترداد إعدادات الملف الشخصي لنشاطك التجاري.

مثال

GET /v1/settings/business/profile

تتضمن الاستجابة الناجحة الكائن profile الذي يحتوي على بيانات ملف النشاط التجاري. وللحصول على وصف إضافي للبيانات، يمكنك الرجوع إلى قائمة المعلمات أدناه.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

إذا كنت تواجه أي أخطاء، فيمكنك الرجوع إلى رسائل الخطأ والحالة.

تحديث إعدادات الملف الشخصي للنشاط تجاري

يمكنك إجراء استدعاء واجهة API POST لتحديث إعدادات الملف الشخصي لنشاطك التجاري.

مثال

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

المعلمات

الاسمالوصف

address

النوع: String (سلسلة)

يمثل عنوان النشاط التجاري. والحد الأقصى لعدد الأحرف هو 256 حرفًا.

description

النوع: String (سلسلة)

وصف النشاط التجاري. الحد الأقصى لعدد الأحرف هو 512 حرفًا.

email

النوع: String (سلسلة)

يمثل عنوان البريد الإلكتروني (بتنسيق صالح) للتواصل مع النشاط التجاري. والحد الأقصى لعدد الأحرف هو 128 حرفًا.

vertical

النوع: String (سلسلة)

يمثل مجال تخصص النشاط التجاري. ويجب أن يكون إحدى القيم المقبولة التالية:

  • Automotive
  • Beauty, Spa and Salon
  • Clothing and Apparel
  • Education
  • Entertainment
  • Event Planning and Service
  • Finance and Banking
  • Food and Grocery
  • Public Service
  • Hotel and Lodging
  • Medical and Health
  • Non-profit
  • Professional Services
  • Shopping and Retail
  • Travel and Transportation
  • Restaurant
  • Other

لا يمكن إعادة مجال النشاط التجاري إلى قيمة فارغة بعد إنشائه.

websites

النوع: Array of strings (مصفوفة السلاسل)

يمثل عناوين URL (بما في ذلك http:// أو https://) المرتبطة بالنشاط التجاري (مثل، موقع الويب وصفحة Facebook وحساب Instagram). علمًا بأن الحد الأقصى لعدد مواقع الويب هو 2 بحد أقصى 256 حرفًا لكل موقع.

التحديثات الجزئية

إذا كنت تحتاج إلى تحديث بعد الحقول بمعلومات جديدة، فيمكنك إجراء طلب لتغيير الحقول الضرورية فقط:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

يعمل الطلب الناجح على إرجاع رمز حالة HTTP وهو 200 OK، وإرجاع null أو {}. إذا كنت تواجه أي أخطاء، فيمكنك الرجوع إلى رسائل الخطأ والحالة.