‏API داخل المواقع الخاصة بمنصة واتساب للأعمال‏

النسخ الاحتياطي والاستعادة

/v1/settings/backup و/v1/settings/restore

استخدم نقطتي النهاية /v1/settings/backup و/v1/settings/restore لتسهيل الانتقال إلى بيئات أو خوادم مختلفة والاستعادة إلى حالة عمل معروفة. ونوصي بعمل نسخ احتياطي من وقت لآخر بحيث إذا تعطل عميل أو خادم بواجهة API الخاصة بتطبيق WhatsApp للأعمال، فيمكنك استعادته وتشغيله مرة أخرى بسهولة.

يدعم عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال النسخ الاحتياطي لكل المعلومات الضرورية واستعادتها، بما في ذلك إعدادات التطبيق والتسجيل.

تحديث الأمان

في v2.31.4، أصلح WhatsApp نقاط نهاية النسخ الاحتياطي والاستعادة للحفاظ على تناسقها مع نموذج الأمان لوظائف النسخ الاحتياطي والاستعادة لدى عملاء WhatsApp الآخرين (أي تطبيقات الهواتف). ومع هذا التغيير، تم إنشاء رمز حماية جديد بين حساب WhatsApp للأعمال وجهات الاتصال بعد عملية الاستعادة الناجحة.

بعد قيام حساب WhatsApp للأعمال بالاستعادة من نسخة احتياطية، سيتلقى العميل المستهلك إشعارًا يفيد بأنه "تم تغيير رمز الحماية مع {Business Account}. اضغط لمعرفة المزيد." إذا تم تمكين إعداد "إشعار الأمان". وتظل كل سلوكيات النسخ الاحتياطي/الاستعادة كما هي من قبل.

قبل البدء

يجب استخدام حساب admin للوصول إلى إعدادات النسخ الاحتياطي والاستعادة.

النسخ الاحتياطي

يتم تشغيل القدرة على النسخ الاحتياطي/التصدير فقط بعد تسجيل وتشغيل عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال. ولن يجري النسخ الاحتياطي نسخًا احتياطيًا للرسائل أو عمليات الاستدعاء ولن يعمل التقاط نُسخ من الجهاز الظاهري واستعادتها.

مثال

للنسخ الاحتياطي، استخدم نقطة النهاية /v1/settings/backup مع الحقل password.

POST /v1/settings/backup
{
    "password": "PASSWORD"
}

A successful response looks like this:

{
    "settings": {
       "data": "ENCRYPTED_BACKUP_DATA"
    }
}

المعلمات

معلمات الطلبات:

الاسمالوصف

password

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

يتم الاستخدام لتشفير بيانات النسخ الاحتياطي لتحقيق الأمان.

معلمات الاستجابة:

الاسمالوصف

settings

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

يمثل الكائن settings الذي يحتوي على العنصر data.

data

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

يمثل البيانات التي تم نسخها احتياطيًا وتشفيرها لتحقيق الأمان. واحفظ القيمة data حيث سيتم استخدامها مع كلمة السر لاستعادة المعلومات.

الاستعادة

يمكن استخدام الاستعادة لإعداد إصدار جديد لدى عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال على جهاز جديد أو لاستعادة التطبيق إلى حالة عمل معروفة على الجهاز نفسه بمعلومات التشفير والإعدادات نفسها الخاصة بعملية الإعداد السابقة.

بالنسبة لإعداد التطبيق على جهاز جديد، يجب تشغيل Coreapp، ولكن بدون تسجيله. وبمجرد نجاح الاستيراد، سيبدأ Coreapp في العمل تلقائيًا ويبدأ في عرض الطلبات. وإذا كان للجهاز تطبيق موجود وقمت بإجراء استعادة، فسيتوقف التطبيق وستحتاج إلى تشغيله مرة أخرى باستخدام الأمر docker restart.

عند استعادة إعداد الاتصال المتعدد، ستحتاج إلى إجراء الاستعادة كأولوية لنوع الإعداد نفسه الذي تقوم بالاستعادة منه. فعلى سبيل المثال، إذا أجريت نسخًا احتياطيًا بقسمين قيد التشغيل، فيجب أن يكون هناك قسمان قيد التشغيل للاستعادة.

مثال

لاستعادة الإعدادات، استخدم نقطة النهاية /v1/settings/restore مع الحقلين password وdata.

POST /v1/settings/restore
{
    "password": "your-password",
    "data": "your-encrypted-backup-data"
}

يتم إيقاف تشغيل عميل API واتساب للأعمال بعد الاستيراد. وفي عمليات نشر معينة (مثل AWS)، ستتم إعادة تشغيل التطبيق تلقائيًا. وإلا، ستضطر إلى إعادة تشغيل الخدمة باستخدام الأمر docker restart.

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

المعلمات

الاسمالوصف

password

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

يمثل كلمة السر التي استخدمتها في استدعاء واجهة API /v1/settings/backup لتشفير بيانات النسخ الاحتياطي.

data

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

يمثل البيانات التي تم إرجاعها من خلال استدعاء واجهة API /v1/settings/backup.