เอกสาร API ของ LocalSERP Proxy

การยืนยันตัวตน

ทุกคำขอ ยกเว้นแค็ตตาล็อกสาธารณะ ต้องมี API key: Authorization: Bearer API_KEY ระบบจะแสดง key แบบเต็ม เพียงครั้งเดียว ตอนสร้าง ให้เก็บรักษาเหมือนรหัสผ่าน คุณเพิกถอน key ได้ทุกเมื่อ หลังจากนั้นคำขอที่ใช้ key ดังกล่าวจะได้รับ 401 unauthorized

curl -s "https://localserpproxy.com/api/v1/balance" \
  -H "Authorization: Bearer $API_KEY"

คำขอและการตอบกลับ

• รับ JSON และส่ง JSON กลับ: ส่ง Content-Type: application/json พร้อมเนื้อหาคำขอ
• รายการ ที่อาจมีจำนวนเพิ่มขึ้นจะแบ่งหน้าโดยใช้ page (เริ่มจาก 1) และ perPage (1–100 ค่าเริ่มต้น 20) และส่งกลับเป็น { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } } รายการสั้น ๆ จะส่งกลับเป็น { "data": [...] }
• ID เป็นสตริงที่ไม่เปิดเผยความหมาย พร้อมคำนำหน้าระบุประเภท: ord_ (คำสั่งซื้อ), top_ (การเติมเงิน), txn_ (รายการเคลื่อนไหวยอดเงิน), res_ (การสมัครแพ็กเกจทราฟฟิก), mob_ (พอร์ตมือถือ), key_ (คีย์ API) และ ipw_ (รายการ IP ที่อนุญาต)
• ลองส่งซ้ำได้อย่างปลอดภัย: POST /v1/orders และ POST /v1/topups รองรับส่วนหัว Idempotency-Key (สตริงใดก็ได้ที่ไม่ซ้ำกัน โดยเก็บไว้ 24 ชม.) เมื่อส่งคีย์เดิมซ้ำ ระบบจะส่งการตอบกลับครั้งแรก แทนการซื้อหรือเติมเงินซ้ำ
• ตัวอย่าง แสดงรูปแบบของคำตอบแต่ละรายการ: ID, IP, จำนวนเงิน และวันที่เป็นข้อมูลประกอบ ส่วน ID แพ็กเกจและราคาเป็นข้อมูลจริง

ข้อผิดพลาด

ข้อผิดพลาดทุกรายการมีเนื้อหาในรูปแบบเดียวกัน code มีค่าคงที่และออกแบบมาให้โค้ดของคุณนำไปใช้ ส่วน message เป็นประโยคภาษาอังกฤษที่อาจเปลี่ยนแปลงได้ ข้อผิดพลาดในการตรวจสอบความถูกต้องจะแสดงฟิลด์ที่ไม่ถูกต้องแต่ละรายการใน fields อาจมีการเพิ่มรหัสใหม่ โปรดจัดการรหัสที่ไม่รู้จักให้เป็นข้อผิดพลาดทั่วไป

{
  "error": {
    "code": "validation_failed",
    "message": "Some fields are invalid.",
    "fields": [
      {
        "field": "amountUsd",
        "code": "too_small",
        "message": "The minimum top-up is 25.00 USD."
      }
    ],
    "requestId": "req_2b7c0f"
  }
}

ขีดจำกัดอัตราการเรียกใช้

ทุกการตอบกลับจะมี RateLimit-Limit, RateLimit-Remaining และ RateLimit-Reset หากเรียกใช้เกินขีดจำกัด API จะตอบกลับด้วย 429 rate_limited พร้อมส่วนหัว Retry-After (หน่วยเป็นวินาที): รอตามเวลาที่ระบุแล้วลองอีกครั้ง เปลี่ยน IP ของพอร์ตมือถือได้ไม่เกินทุก 30 วินาที (429 rotation_too_soon พร้อม Retry-After)