เอกสาร MapScale
•••
แพลตฟอร์มและ SDK
คู่มือแพลตฟอร์ม

การเชื่อมต่อ REST API

เรียก MapScale จากภาษา server ใดก็ได้ผ่าน HTTPS พร้อม JSON และ GeoJSON response

สิ่งที่คุณจะทำได้

ใช้ REST API สำหรับ search, routing, matrix, static image และงานฝั่ง server

Base URL และ authentication

ส่ง production traffic ไปที่ https://api.mapscale.io และส่ง key ผ่าน X-MapScale-Key สำหรับ endpoint ที่ป้องกัน

LIVE API PLAYGROUND

เข้าสู่ระบบหรือสร้างบัญชี

ดำเนินการต่อเพื่อเรียก request จริงจากหน้า docs

แก้ไข input ส่ง request จริง และตรวจสอบ response จริง

input ที่แก้ไขได้

Request preview
curl \
  -H "X-MapScale-Key: $MAPSCALE_API_KEY" \
  "https://api.mapscale.io/v1/geocode?q=Siam+Paragon&lang=th&limit=5"
Response จริง
Response เริ่มต้น
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "place_bangkok_123",
      "text": "Siam Paragon",
      "place_name": "Siam Paragon, Pathum Wan, Bangkok",
      "geometry": {
        "type": "Point",
        "coordinates": [
          100.5348,
          13.7466
        ]
      },
      "properties": {
        "latitude": 13.7466,
        "longitude": 100.5348,
        "formattedAddress": "Siam Paragon, Pathum Wan, Bangkok 10330, Thailand",
        "street": "Rama I Road",
        "neighborhood": "Siam",
        "subdistrict": "Pathum Wan",
        "district": "Pathum Wan",
        "province": "Bangkok",
        "postalCode": "10330",
        "country": "Thailand"
      }
    }
  ]
}

อ่าน response

JSON response ใช้ HTTP status มาตรฐาน Search API ส่งข้อมูลแบบ GeoJSON ส่วน image และ tile endpoint ส่ง binary พร้อม Content-Type ที่เหมาะสม

จัดการ error

400 คือ input ผิด, 401 คือไม่มี auth, 403 คือข้อจำกัดของ key, 429 ให้ชะลอ request และ 5xx ให้ retry แบบจำกัดด้วย exponential backoff

ตัวอย่างที่ 2 — upstream ล้มเหลวแบบ retry ได้

เมื่อ backend ค้นหาที่อยู่ไม่พร้อมใช้งาน API จะตอบ 503 ด้วย shape {error:{code,message}} แบบเดียวกับทุก endpoint ไม่ใช่ 500 เปล่า ๆ หรือหน้า HTML error

LIVE API PLAYGROUND

เข้าสู่ระบบหรือสร้างบัญชี

ดำเนินการต่อเพื่อเรียก request จริงจากหน้า docs

แก้ไข input ส่ง request จริง และตรวจสอบ response จริง

input ที่แก้ไขได้

Request preview
curl \
  -H "X-MapScale-Key: $MAPSCALE_API_KEY" \
  "https://api.mapscale.io/v1/geocode?q=x&lang=th&limit=5"
Response จริง
Response เริ่มต้น
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "place_bangkok_123",
      "text": "Siam Paragon",
      "place_name": "Siam Paragon, Pathum Wan, Bangkok",
      "geometry": {
        "type": "Point",
        "coordinates": [
          100.5348,
          13.7466
        ]
      },
      "properties": {
        "latitude": 13.7466,
        "longitude": 100.5348,
        "formattedAddress": "Siam Paragon, Pathum Wan, Bangkok 10330, Thailand",
        "street": "Rama I Road",
        "neighborhood": "Siam",
        "subdistrict": "Pathum Wan",
        "district": "Pathum Wan",
        "province": "Bangkok",
        "postalCode": "10330",
        "country": "Thailand"
      }
    }
  ]
}
อ่านต่อขั้นตอนถัดไป →

Map sandbox

Previous Page

React และ Next.js

Next Page

On this page

Base URL และ authenticationอ่าน responseจัดการ errorตัวอย่างที่ 2 — upstream ล้มเหลวแบบ retry ได้