موارد خارجية

/v1/certificates/external

استخدم عنصر الربط هذا لتحميل الشهادات الصادرة عن هيئة الشهادات (CA) واستردادها وحذفها وإعادة تعيينها.

قبل البدء

يجب استخدام حساب admin لتحميل جميع الشهادات وحذفها.

الاسترداد

يمكنك إرسال استدعاءات GET إلى نقطة النهاية هذه لاسترداد الشهادة الصادرة عن هيئة الشهادات (CA) والمخزّنة في عميل API الخاصة بواتساب للأعمال.

مثال

الطلب:

GET /v1/certificates/external/ca

الاستجابة:

Content-Type: text/plain
Content-Length: content-size

certificate

إذا لم يتم العثور على شهادة صادرة عن هيئة الشهادات (CA)، فسيتم حينها إرجاع رمز الاستجابة 404 بدون نص أساسي.

التحميل

يمكنك إجراء استدعاءات POST لتحميل شهادة صادرة عن هيئة الشهادات (CA). تأكد من أن الشهادة التي تم تحميلها تتضمن الأقسام التالية في ملف واحد وبالترتيب نفسه كما هو موضح فيما يلي:

1. المفتاح الخاص
2. الشهادة
3. شهادة متوسطة واحدة أو أكثر صادرة عن هيئة الشهادات (CA) — يحتاج عميل API الخاصة بواتساب للأعمال إلى شهادة متوسطة واحدة على الأقل صادرة عن هيئة الشهادات (CA)، وإلا فستفشل عملية التحميل.

مثال

لتحميل الشهادة إلى عميل API الخاصة بواتساب للأعمال، استخدم طلب API التالي الذي يتضمن Content-Type في text/plain.

POST /v1/certificates/external
  Content-Type: text/plain
  Content-Length: content-size

certificate

في حالة استخدام cURL، سيبدو الأمر كما يلي:

curl -X POST \
  https://your-webapp-hostname:your-webapp-port/v1/certificates/external \
  -H 'Authorization: Bearer your-auth-token' \
  -H 'Content-Type: text/plain' \
  --data-binary @your-path-to-certificate.pem 

إذا كانت الشهادة موجودة بالفعل، فسيتم استبدالها. يجب أن تعيد تشغيل خادم الويب، ويعني ذلك جميع مثيلات حاوية Webapp، بمجرد تحميل الشهادة.

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

تبدو استجابة استدعاء API كما يلي:

null

إعادة التعيين

إذا حاولت تحميل شهادة صادرة عن هيئة الشهادات (CA) إلى عميل API الخاصة بواتساب للأعمال وكانت الشهادة غير صالحة لسبب ما، فسيفشل بدء حاويات Webapp عند إعادة التشغيل نظرًا إلى أن نقطة نهاية API ستكون مُعطلة. ولمعالجة هذه الحالة، يجب توفير جدول قاعدة بيانات certs.

لتوفير جدول قاعدة بيانات certs:

1. أوقف حاوية Webapp:
   

   docker stop your-webapp-container-id

2. اتصل بـ MySQL عبر Docker في سطر الأوامر:

   docker exec -it your-mysql-container-id mysql -uroot -p

3. أدخل كلمة سر MySQL عندما يُطلب منك ذلك (حسب mysql.conf).
4. تحقق مما إذا كان جدول certs موجودًا أم لا:

   show tables in waweb;

5. قم بتوفير جدول certs:

   drop table waweb.certs;

6. قم بإنهاء MySQL:

   exit;

7. أعد تشغيل حاوية Webapp:

   docker restart your-webapp-container-id

8. قم بتسجيل الدخول إلى MySQL مرة أخرى باستخدام الخطوات السابقة للتأكد من أن جدول certs متواجد حاليًا.

الحذف

حذف الشهادات غير مدعوم. يمكن أن ندعم ذلك في المستقبل إذا لاحظنا وجود حالة استخدام.