راقب استخدام مفتاحك قبل أن تبلغ الحد
متابعة ترويسات الحصة أولًا بأول تخبرك متى يقترب الحد، قبل وقت طويل من رفض أي طلب فعليًا.
أرسل مفتاح API بثلاث طرق مختلفة (ولماذا يهم ذلك)
لا تتعامل كل الأدوات التي تتصل بواجهة API مع المصادقة بالطريقة نفسها، ولهذا تقبل الواجهة المفتاح عبر أكثر من آلية بدلًا من فرض كل شيء عبر اسم ترويسة واحد.
الترويسة X-API-Key
هذا هو الخيار الأكثر مباشرة: ترويسة مخصصة لا تحمل شيئًا سوى المفتاح.
GET /v1/forward?q=Baker+Street
X-API-Key: mg_live_examplekey123Authorization: Bearer
بعض عملاء HTTP وبوابات API مهيأة أصلًا لإرفاق رمز Bearer بكل طلب صادر، واستخدام هذه الآلية يعني أنك لا تحتاج إلى إضافة ترويسة ثانية خاصة بالواجهة إلى جانبه.
GET /v1/forward?q=Baker+Street
Authorization: Bearer mg_live_examplekey123مصادقة HTTP Basic
الأدوات الأقدم، وبعض عمليات التكامل بين الخوادم المبنية لمزودين آخرين، تتوقع بيانات الاعتماد على شكل مصادقة HTTP Basic. يوضع المفتاح في خانة اسم المستخدم، وتُترك كلمة المرور فارغة.
GET /v1/forward?q=Baker+Street
Authorization: Basic bWdfbGl2ZV9leGFtcGxla2V5MTIzOg==معلمة استعلام لكل ما عدا ذلك
حين لا تمنحك أداة ما أي تحكم في الترويسات على الإطلاق، كاختبار سريع في شريط عنوان المتصفح أو عميل لا يدعم إلا الإعداد عبر URL، يمكن أيضًا تمرير المفتاح كمعلمة استعلام مباشرة في الطلب.
GET /v1/forward?q=Baker+Street&key=mg_live_examplekey123لماذا يهم الاختيار عمليًا
المفتاح المرسل كمعلمة استعلام ينتهي به المطاف في سجلات الخوادم وسجل المتصفح وترويسات Referer بسهولة أكبر من المفتاح المرسل في ترويسة الطلب، لذا فضّل طريقة قائمة على الترويسات كلما كان للشيفرة المستدعية أي تحكم في ذلك. والطرق الأربع تعمل بالطريقة نفسها تمامًا مع كل نقطة نهاية وكل مضيف توافق، لذا فإن التبديل بينها لاحقًا، كأن تنقل سكربتًا من اختبار في المتصفح إلى تكامل خلفي حقيقي، لا يغير شيئًا في طريقة احتساب الحصة أو الرصيد على المفتاح.
استخدام ذلك عبر مضيفات التوافق
كل واحد من مضيفات التوافق البالغ عددها 17 يقبل بيانات الاعتماد بالأسلوب نفسه الذي استخدمه المزود الأصلي، لذا فإن السكربت المكتوب وفق أسلوب المصادقة لدى مزود آخر يستمر عمومًا في العمل بعد توجيهه إلى مضيف التوافق المقابل لدى My Geocode، دون إعادة كتابة طريقة إرسال المفتاح. راجع صفحة التوافق للاطلاع على قائمة المضيفات وأسلوب بيانات الاعتماد الذي يتوقعه كل منها.
خطأ يستحق التجنب
اختبار سكربت مع وضع المفتاح كمعلمة استعلام ثم تركه على هذه الحال في بيئة الإنتاج عادة يسهل اكتسابها، لأن معلمة الاستعلام غالبًا ما تكون أسرع طريقة لتشغيل أول طلب. انتقل إلى طريقة قائمة على الترويسات، X-API-Key أو Authorization، قبل أن يقترب السكربت من حركة الإنتاج أو يُرفع إلى مستودع مشترك، لأن المفتاح الظاهر في URL أكثر عرضة بكثير لأن ينتهي في مكان لم تقصده، مثل سجل وكيل أو ملف سجل المتصفح على جهاز مشترك.
لا فرق في التكلفة
لا تغير أي من هذه الطرق طريقة احتساب تكلفة الطلب. فكل طلب على المفتاح يُحتسب بالطريقة نفسها من 2,500 طلب مجاني يوميًا، وبعد ذلك من الرصيد المسبق الدفع أو من باقة Unlimited.
اختيار طريقة المصادقة المناسبة يتعلق أساسًا بمطابقة ما تدعمه الأداة المستدعية أصلًا، لا بالأداء أو التكلفة. التفاصيل الكاملة في توثيق المصادقة.