تنسيق خطأ JSend
تُرجع الطلبات الفاشلة status error وmessage وcode وdata بصيغة JSend. اقرأ message وcode دائماً. الأسباب الشائعة: عدم تفعيل API، JWT منتهي، أرقام غير صالحة.
مثال على استجابة خطأ
مثال على خطأ تحقق عند غياب حقل مطلوب.
curl -X POST 'https://app.buzzbip.com/api/contacts/' \
-H 'Authorization: Bearer ${TOKEN}' \
-H 'Content-Type: application/json' \
-d '{"firstname": "Jane"}'قائمة فحص تصحيح الأخطاء
تأكد من تنسيق Authorization (Bearer بمسافة واحدة). تحقق من الشرطات النهائية. تأكد من تفعيل hasApiAccess. سجّل status وmessage وdata معاً. اختبر أولاً بـ GET /api/contacts/.
سجّل جسم JSend الكامل عند الأخطاء — نص الرسالة أسرع دليل.
ملاحظات التكامل
عند دمج نقطة نهاية Buzzbip هذه، استخدم https://app.buzzbip.com كمضيف إنتاج. احصل على JWT من POST /api/login_check وأرسل Authorization: Bearer في كل طلب. تأكد من تفعيل User.hasApiAccess في إدارة Buzzbip. حلّل استجابات JSend (status وmessage وdata). لإضافات التجارة الإلكترونية، أرسل أيضاً x-api-key وx-platform-type وx-base-uri. احترم الشرطة المائلة النهائية في POST /api/contacts/ وPOST /api/whatsapp/. نفّذ إعادة المحاولة مع backoff عند حدود المعدل. خزّن بيانات الاعتماد على الخادم وأعد المصادقة قبل انتهاء JWT (3600 ثانية).
الأمان
أفضل الممارسات: بيانات الاعتماد على الخادم فقط، TLS إلزامي، مراقبة فشل المصادقة. افصل حسابات التجربة والإنتاج. وثّق القوالب والأتمتة. احذف الأرقام والمحتوى من السجلات المشتركة.
ما التالي؟
العودة إلى موارد API: api/contacts getting-started/authentication api/secret-key