Tài liệu & Hướng dẫn

Cách hoạt động

1. Máy chủ của bạn gửi danh sách URL trang tới IndexLaunch, được ký bằng khóa API của bạn.
2. IndexLaunch kiểm tra từng URL, trừ một credit cho mỗi URL và gửi tới các công cụ tìm kiếm để thu thập dữ liệu. Bạn nhận lại một ID cho mỗi URL.
3. Dùng các ID đó để kiểm tra trạng thái từng URL bất cứ lúc nào.

Thiết lập trong 4 bước

1. Đăng nhập và tạo khóa trong Cài đặt → Truy cập API. Khóa chỉ hiển thị một lần, vì vậy hãy sao chép ngay.
2. Lưu khóa dưới dạng biến môi trường bí mật trên máy chủ hoặc CI của bạn, ví dụ INDEXLAUNCH_API_KEY. Tuyệt đối không đặt khóa trong mã chạy trên trình duyệt hoặc trong kho mã công khai.
3. Xác minh từng tên miền mà bạn sẽ gửi URL (Settings → Domain Verification). Công cụ tìm kiếm từ chối URL từ các trang web chưa được xác minh.
4. Gọi API từ backend, một script hoặc quy trình triển khai của bạn. Các ví dụ bên dưới có thể sao chép và dùng ngay.

Xác thực

Gửi khóa trong header Authorization của mọi yêu cầu dưới dạng Bearer YOUR_KEY. Mọi yêu cầu đều dùng HTTPS và JSON.

Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx

Gửi URL

Gửi tối đa 500 URL đầy đủ (bắt đầu bằng https://) mỗi yêu cầu. Mỗi URL tốn một credit. Phản hồi liệt kê một ID cho mỗi URL, theo đúng thứ tự bạn đã gửi.

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..."] }

Kiểm tra trạng thái URL

Truyền một ID từ phản hồi gửi URL. Bạn chỉ có thể xem các URL do chính tài khoản của bạn gửi.

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
}

Các trường phản hồi

id

ID của lượt gửi.

url

URL bạn đã gửi.

status

Một trong các giá trị trạng thái bên dưới.

submittedAt

Thời điểm gửi, tính bằng mili giây kể từ Unix epoch.

indexedAt

Thời điểm công cụ tìm kiếm chấp nhận URL. Không có cho đến lúc đó.

Giá trị trạng thái

pending

Đã nhận và đang chờ gửi đi. Hầu hết URL được xử lý tiếp trong vài phút.

indexed

Đã được công cụ tìm kiếm chấp nhận và xếp hàng chờ thu thập dữ liệu. Bảng điều khiển hiển thị trạng thái này là “Submitted”. Điều này chưa xác nhận trang đã được index.

failed

Công cụ tìm kiếm không chấp nhận URL, thường nhất là do tên miền chưa được xác minh. Credit được hoàn lại tự động.

refunded

URL bị kẹt hơn 7 ngày nên credit đã được hoàn lại tự động.

Ví dụ mã

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"]}'

Lỗi

Lỗi trả về JSON có trường error chứa thông báo mà bạn có thể hiển thị hoặc ghi log.

400

Yêu cầu không hợp lệ: body không có danh sách urls, có URL không hợp lệ, gửi hơn 500 URL, không đủ credit hoặc gửi yêu cầu quá nhanh.

401

Khóa bị thiếu, sai hoặc đã bị thu hồi.

403

Tài khoản đã bị tạm ngưng.

404

Không có lượt gửi nào với ID đó thuộc tài khoản của bạn.

Thực hành tốt

• Chỉ gửi các trang mới hoặc đã thay đổi, không gửi toàn bộ trang web sau mỗi lần triển khai.
• Gộp các URL vào một yêu cầu thay vì gửi một yêu cầu cho mỗi URL.
• Nếu bạn nhận được “Too many requests” hoặc thông báo giới hạn tần suất, hãy đợi một phút rồi thử lại. Giới hạn cụ thể của tài khoản bạn hiển thị trong Cài đặt → Truy cập API.
• Nếu khóa bị lộ, hãy thu hồi khóa trong Cài đặt và tạo khóa mới. Khóa đã thu hồi ngừng hoạt động ngay lập tức.