เอกสารและคู่มือ

วิธีการทำงาน

1. เซิร์ฟเวอร์ของคุณส่งรายการ URL ของหน้าเว็บไปยัง IndexLaunch โดยลงนามด้วยคีย์ API ของคุณ
2. IndexLaunch ตรวจสอบแต่ละ URL หักเครดิต 1 เครดิตต่อ URL และส่งไปยังเครื่องมือค้นหาเพื่อ crawl คุณจะได้รับ ID หนึ่งรายการต่อ URL
3. ใช้ ID เหล่านั้นตรวจสอบสถานะของแต่ละ URL ได้ทุกเมื่อ

ตั้งค่าใน 4 ขั้นตอน

1. เข้าสู่ระบบแล้วสร้างคีย์ใน การตั้งค่า → การเข้าถึง API คีย์จะแสดงเพียงครั้งเดียว ดังนั้นให้คัดลอกทันที
2. เก็บคีย์เป็นตัวแปรสภาพแวดล้อมแบบลับบนเซิร์ฟเวอร์หรือ CI ของคุณ เช่น INDEXLAUNCH_API_KEY ห้ามใส่คีย์ไว้ในโค้ดฝั่งเบราว์เซอร์หรือในรีโพสิทอรีสาธารณะเด็ดขาด
3. ยืนยันทุกโดเมนที่คุณจะส่ง URL (Settings → Domain Verification) เครื่องมือค้นหาจะปฏิเสธ URL จากเว็บไซต์ที่ยังไม่ได้ยืนยัน
4. เรียก API จากแบ็กเอนด์ สคริปต์ หรือไปป์ไลน์การดีพลอยของคุณ ตัวอย่างด้านล่างพร้อมให้คัดลอกไปใช้

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

ส่งคีย์ของคุณในเฮดเดอร์ Authorization ของทุกคำขอในรูปแบบ Bearer YOUR_KEY ทุกคำขอใช้ HTTPS และ JSON

Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx

ส่ง URL

ส่ง URL แบบเต็ม (ขึ้นต้นด้วย https://) ได้สูงสุด 500 รายการต่อคำขอ แต่ละ URL ใช้ 1 เครดิต การตอบกลับจะมี ID หนึ่งรายการต่อ URL เรียงตามลำดับเดียวกับที่คุณส่ง

POST https://www.indexlaunch.site/api/v1/submit
Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

{ "urls": ["https://example.com/page-1", "https://example.com/page-2"] }

200 OK
{ "submitted": 2, "ids": ["j57...", "j58..."] }

ตรวจสอบสถานะ URL

ส่ง ID ที่ได้จากการตอบกลับของการส่ง คุณดูได้เฉพาะ URL ที่ส่งจากบัญชีของคุณเองเท่านั้น

GET https://www.indexlaunch.site/api/v1/urls/j57...
Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx

200 OK
{
  "id": "j57...",
  "url": "https://example.com/page-1",
  "status": "indexed",
  "submittedAt": 1757740800000,
  "indexedAt": 1757741100000
}

ฟิลด์ในการตอบกลับ

id

ID ของการส่ง

url

URL ที่คุณส่ง

status

ค่าสถานะค่าใดค่าหนึ่งด้านล่าง

submittedAt

เวลาที่ส่ง เป็นมิลลิวินาทีนับจาก Unix epoch

indexedAt

เวลาที่เครื่องมือค้นหายอมรับ จะไม่มีค่านี้จนกว่าจะถึงตอนนั้น

ค่าสถานะ

pending

ได้รับแล้วและกำลังรอส่ง URL ส่วนใหญ่จะไปสู่ขั้นถัดไปภายในไม่กี่นาที

indexed

เครื่องมือค้นหายอมรับแล้วและอยู่ในคิวรอ crawl แดชบอร์ดจะแสดงสถานะนี้เป็น "Submitted" ซึ่งยังไม่ได้ยืนยันว่าหน้าเว็บติดดัชนีแล้ว

failed

เครื่องมือค้นหาไม่ยอมรับ URL นี้ ส่วนใหญ่เป็นเพราะโดเมนยังไม่ได้รับการยืนยัน เครดิตจะคืนให้โดยอัตโนมัติ

refunded

URL ค้างอยู่นานกว่า 7 วัน จึงคืนเครดิตให้โดยอัตโนมัติ

ตัวอย่างโค้ด

curl -X POST https://www.indexlaunch.site/api/v1/submit \
  -H "Authorization: Bearer $INDEXLAUNCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://example.com/new-post"]}'

const res = await fetch("https://www.indexlaunch.site/api/v1/submit", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.INDEXLAUNCH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    urls: ["https://example.com/new-post", "https://example.com/pricing"],
  }),
});

const data = await res.json();
if (!res.ok) throw new Error(data.error);
console.log(`Submitted ${data.submitted} URLs`, data.ids);

import os
import requests

res = requests.post(
    "https://www.indexlaunch.site/api/v1/submit",
    headers={"Authorization": f"Bearer {os.environ['INDEXLAUNCH_API_KEY']}"},
    json={"urls": ["https://example.com/new-post"]},
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(data["error"])
print(data["submitted"], data["ids"])

# .github/workflows/indexlaunch.yml
name: Submit new pages
on:
  workflow_dispatch:
  push:
    branches: [main]

jobs:
  submit:
    runs-on: ubuntu-latest
    steps:
      - name: Send changed URLs to IndexLaunch
        env:
          INDEXLAUNCH_API_KEY: ${{ secrets.INDEXLAUNCH_API_KEY }}
        run: |
          curl --fail-with-body -X POST https://www.indexlaunch.site/api/v1/submit \
            -H "Authorization: Bearer $INDEXLAUNCH_API_KEY" \
            -H "Content-Type: application/json" \
            -d '{"urls": ["https://example.com/new-post"]}'

ข้อผิดพลาด

เมื่อเกิดข้อผิดพลาด ระบบจะส่ง JSON ที่มีฟิลด์ error ซึ่งเก็บข้อความที่คุณนำไปแสดงหรือบันทึกล็อกได้

400

คำขอไม่ถูกต้อง: เนื้อหาคำขอไม่มีรายการ urls มี URL ที่ไม่ถูกต้อง ส่ง URL เกิน 500 รายการ เครดิตไม่พอ หรือส่งคำขอถี่เกินไป

401

ไม่มีคีย์ คีย์ไม่ถูกต้อง หรือคีย์ถูกเพิกถอนแล้ว

403

บัญชีถูกระงับ

404

ไม่มีการส่งที่มี ID นี้ในบัญชีของคุณ

แนวทางที่ดี

• ส่งเฉพาะหน้าใหม่หรือหน้าที่มีการเปลี่ยนแปลง ไม่ใช่ทั้งเว็บไซต์ทุกครั้งที่ดีพลอย
• รวม URL ไว้ในคำขอเดียว แทนการส่งคำขอแยกสำหรับแต่ละ URL
• หากได้รับข้อความ "Too many requests" หรือข้อความเกี่ยวกับการจำกัดอัตรา ให้รอหนึ่งนาทีแล้วลองใหม่ ขีดจำกัดที่แน่นอนของบัญชีคุณแสดงอยู่ใน การตั้งค่า → การเข้าถึง API
• หากคีย์รั่วไหล ให้เพิกถอนคีย์ในการตั้งค่าและสร้างคีย์ใหม่ คีย์ที่ถูกเพิกถอนจะหยุดทำงานทันที