ويب هوك واحد، استدعاء HTTP واحد، قرار واحد. يوضح هذا الدليل لفريق نظام إدارة المحتوى المجزأ كيفية التعامل مع الخطاف، والاستدعاءات، وحالات الفشل.
فريق أبحاث Contentin ·
تحديد ما يمكن أن تفعله بوابة الفحص
فحص الروابط الخلفية للصفحة ضمن سير العمل للإطلاق هو مهمة صغيرة. حافظ على صغرها. الجزء الصعب هو تحديد ما هو مسموح بتغييره في الإجابة، لأن رسم الروابط الذي يتم تحديثه شهريًا لا يمكنه رفض صفحة بمفرده.
نقترح أن تقوم البوابة بإصدار تحذير، وتسجيل الحدث، والسماح ببناء الصفحة. يمكن تغيير الافتراضيات. الحظر الصارم ينطبق على الأشياء التي تتحكم فيها، مثل العلامات التالفة أو علامة canonical المفقودة. بيانات الروابط هي إشارة، والإشارات تتغير.
اكتبها. افعل ذلك قبل البرمجة. سياسة موجزة مثل "تحذير المحرر، وضع علامة على الإدخال، عدم إيقاف النشر" توفر نقاشًا طويلاً في الساعة 6 مساءً يوم الإطلاق. كما تخبر المهندس التالي أي الأخطاء كانت مقصودة وأيها كانت أخطاء برمجية، وهو أمر مهم أكثر مما يبدو. راجعها مرة واحدة كل ربع سنة.
ست خطوات من نقرة النشر إلى الملاحظة المخزنة
1
اختر الزناد
اشترك في حدث النشر الخاص بنظام إدارة المحتوى الخاص بك. يمكن لـ Contentful و Sanity و Strapi استدعاء عنوان URL تملكه عند نشر إدخال، وتوفر Storyblok و Payload أيضًا الويب هوك أو الخطافات. قم بالتصفية لأنواع المحتوى التي تحتوي على عناوين URL الصادرة أو canonical.
2
اختصار العنوان URL إلى نطاق
تأخذ الـ API نطاقًا في q، لذا يجب تحويل https://www.example.com/blog/post?x=1 إلى example.com أولاً. قرر مرة واحدة كيفية التعامل مع www، واختبر نطاقًا حقيقيًا في الإجراء المجاني domain قبل بناء أي شيء.
3
استدعاء الإجراء المجاني أولاً
overview لا يكلف شيئًا. إذا كانت النتيجة رقيقة، فقد يكون النطاق جديدًا أو غير معروف في فهرسنا. هذا ليس دليلًا على أي شيء سيء.
4
أنفق الرصيد فقط عند تفعيل قاعدة
عندما تقول قاعدتك "انظر عن كثب"، استدعِ backlinks مع per=100. يكلف ذلك 2 رصيد، بغض النظر عن عدد الصفوف، لذا اطلب صفحة مفيدة من الصفوف بدلاً من عشر صفحات صغيرة.
5
اكتب ملاحظة، وليس JSON الخام
احكم حكمًا قصيرًا في حقل خاص بك، بالإضافة إلى تاريخ الفحص. تستهلك الاستجابات الخام إدخالاتك وتشيخ بسرعة، لأن الفهرس يتحرك كل شهر.
6
فشل ناعم
يعني HTTP 401 أن المفتاح مفقود أو غير صحيح، لذا قم بتنبيه شخص. يعني HTTP 402 أن الرصيد قد نفد. أي خطأ آخر: سجله، تخطى الفحص، واسمح للنشر بالاستمرار.
أين يوجد المفتاح وماذا يجب أن يفعل 402
يحمل كل استدعاء مدفوع مفتاحك، إما في سلسلة الاستعلام أو في رأس Bearer. يفضل استخدام الرأس. يمكن أن تنتهي سلسلة الاستعلام في سجلات الخادم وتتبع الوكيل، بينما يبقى الرأس عادةً خارجها.
احفظ المفتاح كسرية في منصة الاستضافة الخاصة بك، وليس في الإدخال نفسه. يمكن للمحررين قراءة أي حقل يمكنهم فتحه، لكن بيئة الوظيفة تكون مرئية عادةً فقط للأشخاص الذين يديرون عمليات النشر.
أين يجب أن يعيش المفتاح؟
المفتاح الذي يتسرب يمكن أن ينفد رصيدك، لذا عامله مثل كلمة المرور. احتفظ به خارج المستودع وخارج نظام إدارة المحتوى، وقم بتدويره إذا أظهر ملف السجل أنه موجود كنص عادي.
علّم سجلاتك الخاصة باسم الخطاف. يصبح الإنفاق سهل التتبع إلى وظيفة واحدة، حتى عندما تشارك عدة خطافات نفس الحساب.
هل يمكن لأداة بدون كود إجراء الاستدعاء؟
نعم، عندما يكون للأداة خطوة طلب HTTP عادي. يمكن للعديد من أدوات الأتمتة إرسال طلب GET مع سلسلة استعلام وقراءة JSON مرة أخرى، لذا لا يحتاج الإجراء المجاني overview إلى أي كود على الإطلاق.
ابدأ بالإجراءات المجانية فقط. يمكن أن ينفد التدفق الذي ينطلق عند كل حفظ مسودة رصيدًا أسرع مما يلاحظه المحرر، لذا أضف خطوة مدفوعة بمجرد أن تعمل الاستدعاءات المجانية بهدوء لبعض الوقت.
ما الذي يجب أن يفعله 402؟
يعني 402 أن الرصيد فارغ. لا يقول شيئًا عن الصفحة. تخطى الفحص المدفوع، سجل الحدث، وأرسل تنبيهًا واحدًا للشخص الذي يضيف الرصيد، ثم اسمح للنشر بالاستمرار.
حدد إنذار رصيد أعلى بكثير من الصفر، حتى يصل التحذير بينما لا يزال هناك وقت لإضافة الرصيد. حلقة إعادة المحاولة لن تساعد هنا، لأن كل استدعاء يفشل بنفس الطريقة حتى يضيف شخص رصيدًا. يحتوي جدول التكلفة على الأرقام.
اختبر الاستدعاءين من طرفية
قم بتشغيل هذه مرة واحدة ضد نطاق تعرف عليه قبل أن يقوم الخطاف بذلك لك. اقرأ حقل _credits في الاستجابة الثانية.
bash
# free, no key
curl -s "https://contentin.app/api.php?action=overview&q=example.com"
# 2 credits, key in a header
curl -s -H "Authorization: Bearer sk_live_..." \
"https://contentin.app/api.php?action=backlinks&q=example.com&per=100"
أي نطاق يذهب إلى معلمة q
تأخذ الـ API نطاقًا عاريًا في q، لذا يجب اختصار عنوان URL الكامل أولاً. اكتب هذا الاختصار مرة واحدة، في وظيفة واحدة. ثم اختبره على عناوين URL حقيقية.
الروابط النسبية والبروتوكولات المفقودة هي الحالات التي تكسر الخطاف عادةً. الاختصار الذي يعمل على أمثلة نظيفة قد يفشل بعد ذلك مع عناوين URL الفوضوية التي يلصقها المحرر في الساعة 5 مساءً.
هل يغير www الإجابة؟
قد يفعل، والطريقة الصادقة لمعرفة ذلك هي السؤال. قم بتشغيل إجراء النطاق المجاني على شكلين لموقع تعرف عليه، ثم قارن الاستجابتين جنبًا إلى جنب.
بغض النظر عن القاعدة التي تختارها، اكتبها في تعليق كود حتى لا يضطر المهندس التالي للتخمين. لا يكلف التعليق شيئًا ويوفر نقاشًا طويلاً لاحقًا.
ماذا عن إعادة التوجيه والنطاقات الفرعية؟
أرسل المضيف الذي يهبط عليه القراء فعليًا، وليس الرابط الذي ألصقه المحرر قبل سنوات. إذا كان ذلك الرابط يعيد التوجيه، فاختصر العنوان النهائي وتجاهل القفزة بينهما.
مدونة على نطاق فرعي خاص بها هي حالة حكم. قرر مسبقًا ما إذا كان يتم فحصها بمفردها أو مع النطاق الرئيسي الخاص بها، واكتب هذا الاختيار بجانب القاعدة.
قائمة مراجعة ما قبل الإطلاق للخطاف
ينطلق الخطاف عند النشر فقط، وليس عند كل حفظ مسودة
يتم اختصار العنوان URL إلى نطاق عاري قبل الاستدعاء
تعمل الإجراءات المجانية أولاً ويتم إنفاق الرصيد فقط عند العلم
لـ 401 و 402 كل منهما تنبيه خاص به ورسالة خاصة به
يتم تعيين مهلة زمنية، حتى لا يتوقف API البطيء المحرر
تحتوي الملاحظة المخزنة على تاريخ، حتى لا يخطئ أحد في اعتبارها بيانات حية
نشر نفس الإدخال مرتين لا ينفق الرصيد مرتين (انظر قائمة الأساطير)
سطر السجل لكل فحص تم تخطيه هو أرخص مسار تدقيق يمكنك بناؤه. سجل معرف الإدخال، والنطاق الذي أرسلته، ورمز الحالة، وما إذا كانت خطوة مدفوعة قد تعمل. عادةً ما يكون ذلك كافيًا.
تبقى الملاحظة المخزنة قصيرة ومؤرخة، كما تقول الخطوات أعلاه. تنتمي الاستجابات الكاملة إلى سجلاتك الخاصة، إذا كانت تنتمي إلى أي مكان، لأنها كبيرة وتشخب بسرعة.
ما هي الحقول التي تنتمي إلى سطر السجل؟
ابدأ بمعرف الإدخال وإصدار النشر. ثم يظهر الويب هوك المكرر كزوج نفسه مرتين، وهو بالضبط ما تريد رؤيته.
أضف النطاق، واسم الإجراء، ورمز الحالة، والوقت الذي بدأ فيه الاستدعاء. اترك المفتاح نفسه خارجًا، لأن السجل الذي يحتوي عليه يصبح مكانًا ثانيًا للعيش فيه الأسرار.
كم يجب أن تعيش الملاحظة المخزنة؟
طالما أن الإدخال موجود، ما لم تحل محلها فحص أحدث. ما يهم هو أن القارئ يمكنه معرفة عمر الملاحظة، لأن ملاحظة من أشهر قديمة تقرأ كبيانات حية.
يوضح دليل حقل النقاط الحقول الأربعة التي نقترحها لتلك الملاحظة، بما في ذلك التاريخ.
اختبر الخطاف على بيئة الاختبار قبل الإطلاق
قم بتشغيل هذه الفحوصات الأربع قبل أن يعتمد أي شخص على الخطاف.
1
أعد تشغيل نشر سابق واحد
شغل الخطاف بنسخة من إدخال نشرته بالفعل. قارن الملاحظة المخزنة بما توقعت، وتأكد من أن نفس الإدخال لم يُفوت عليه الرصيد مرتين.
2
جرب نطاقًا مسجلاً مؤخرًا
استخدم نطاق شريك جديد عليك. يجب تخزين الإجابة الفارغة أو الرقيقة كغير معروفة، وليس كفشل، ويجب أن تقول الملاحظة ذلك بكلمات واضحة.
3
فرض 402 عن قصد
شغل الخطاف بمفتاح على حساب اختبار قمت بتفريغ رصيده. تأكد من أن التخطي، وخط السجل، والتنبيه جميعها تنطلق، وأن النشر لا يزال يصل إلى البناء.
4
اقرأ الرسالة التي يراها المحرر
اطلب من شخص خارج الفريق قراءة نص الخطأ بصوت عالٍ. إذا لم يتمكنوا من القول ماذا يجب أن يفعلوا بعد ذلك، أعد كتابة الرسالة قبل يوم الإطلاق. يظهر ما بعد الحادث ما كلفته رسالة غامضة لفريق مخترع واحد.
ما لا يمكن للخطاف رؤيته
يتم تحديث فهرسنا تقريبًا مرة واحدة في الشهر. لن يظهر الرابط المضاف بعد آخر تحديث، وقد يظهر الرابط الذي تمت إزالته منذ ذلك الحين. للإثبات في نفس اليوم، استخدم تقرير الروابط في Google Search Console.
