الترميز الجغرافي الأمامي

حوّل النص إلى إحداثيات. يقبل العناوين الكاملة والعناوين الجزئية والرموز البريدية وأسماء الأماكن ونقاط الاهتمام، بأي لغة.

المعاملات

مثال

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/forward?q=Dam+1,+Amsterdam&countries=nl&limit=1"

const url = new URL("https://api.mygeocode.com/v1/forward");
url.searchParams.set("q", "Dam 1, Amsterdam");
url.searchParams.set("countries", "nl");
url.searchParams.set("limit", "1");

const data = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(data.results[0]);

import requests

r = requests.get("https://api.mygeocode.com/v1/forward",
                 params={"q": "Dam 1, Amsterdam", "countries": "nl", "limit": 1}, headers={"X-API-Key": "YOUR_KEY"}, timeout=10)
print(r.json()["results"][0])

{
  "status": "ok",
  "query": "Dam 1, Amsterdam",
  "results": [
    {
      "formatted": "Dam 1, 1012 JS Amsterdam, Netherlands",
      "lat": 52.373119,
      "lon": 4.893604,
      "type": "address",
      "precision": "house",
      "confidence": 0.98,
      "place_id": "nl.addr.c21d40e8",
      "components": {
        "house_number": "1",
        "road": "Dam",
        "neighbourhood": "Centrum",
        "city": "Amsterdam",
        "state": "North Holland",
        "state_code": "NH",
        "postcode": "1012 JS",
        "country": "Netherlands",
        "country_code": "nl"
      },
      "bounds": { "north": 52.373519, "south": 52.372719, "east": 4.894204, "west": 4.893004 }
    }
  ]
}

حقول الاستجابة

مفاتيح المكونات

لا توجد إلا المفاتيح التي تنطبق. وتُستخدم المفاتيح نفسها في كل الدول.

ملاحظات

• تُرتَّب النتائج وفق مزيج من الثقة والدقة والقرب. النتيجة الأولى هي التي تُستخدم ما لم تكن تعرض قائمة اختيار.
• عندما يتعذر العثور على رقم منزل في شارع معروف، تحمل النتيجة type: street وprecision: street مع استيفاء الرقم حيث تسمح البيانات. تحقق من precision إن كان ذلك يهمك.
• الرموز البريدية وحدها مقبولة في q. لأحمال العمل المقتصرة على الرموز البريدية تكون نقطة نهاية الرمز البريدي أسرع وتعيد اسم المكان المعتمد لدى هيئة البريد.
• يعمل الاستعلام المكتوب بنظام كتابة لمكان يستخدم نظامًا آخر (بالسيريلية لعنوان ياباني مثلًا)، لكن lang هو ما يحدد نظام الكتابة في الاستجابة.

الاستعلام نفسه بصيغ المزوّدين الآخرين

إذا كان لديك كود مكتوب بالفعل لأحد هؤلاء المزوّدين فاحتفظ به: يقبل المضيف البديل المتوافق المسار والمعاملات نفسها ويجيب بشكل استجابة ذلك المزوّد، وخلفه نقطة النهاية هذه. راجع كيف تعمل المضيفات البديلة المتوافقة.

الاستعلامات المجمّعة

أرسل جسم JSON إلى المسار نفسه بطريقة POST يحتوي على queries، وهي مصفوفة تضم حتى 100 عنوان، وستحمل الإجابة مصفوفة results فيها إدخال واحد لكل استعلام بترتيب الإرسال. يُحتسب كل إدخال طلبًا واحدًا، والدفعة الأكبر مما تبقى من الحصة تُرفض كاملة.

$ curl -X POST "https://api.mygeocode.com/v1/forward" -H "Content-Type: application/json" -d '{"queries": ["Brandenburg Gate, Berlin", "Bahnhofstrasse 1, Zurich"]}'

الأخطاء

400 invalid_request عندما لا يوجد q ولا حقل منظَّم ولا place_id، أو عندما تكون limit خارج النطاق من 1 إلى 10، أو عندما تكون bounds أو proximity مشوّهة الصيغة. راجع الأخطاء لمعرفة البقية.