IndexBolt
Tham chiếu API

Tài liệu API lập chỉ mục URL

API lập chỉ mục URL của IndexBolt cho phép bạn gửi URL đến Google để lập chỉ mục, theo dõi tiến trình gửi và quản lý tín dụng theo phương thức lập trình. Tích hợp lập chỉ mục URL hàng loạt vào quy trình SEO, plugin WordPress hoặc các công cụ tùy chỉnh của bạn.

URL cơ sở: https://www.indexbolt.com/api/v1•Yêu cầu & phản hồi JSON•Xác thực Bearer token

Xác thực#

Tất cả yêu cầu API đều cần một Bearer token trong header Authorization. Tạo khóa API từ cài đặt bảng điều khiển của bạn.

Header yêu cầu ví dụ
Authorization: Bearer ib_your_api_key_here
Quan trọng: Khóa API bắt đầu bằng tiền tố ib_. Giữ bí mật khóa của bạn — không để lộ chúng trong mã phía client. Bạn có thể tạo tối đa 5 khóa API cho mỗi tài khoản.

Giới hạn tốc độ#

Giới hạn tốc độ được áp dụng cho mỗi khóa API bằng cách sử dụng cửa sổ trượt. Khi bị giới hạn tốc độ, bạn sẽ nhận được mã trạng thái 429.

EndpointGiới hạnCửa sổ
POST /submit10 yêu cầu60 giây
GET /balance30 yêu cầu60 giây
GET /submissions, /submissions/:id60 yêu cầu60 giây

Các header phản hồi X-RateLimit-Remaining và X-RateLimit-Reset cho biết mức sử dụng hiện tại của bạn.

Xử lý lỗi#

Tất cả lỗi đều trả về một cấu trúc JSON nhất quán:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}
Trạng thái HTTPMãMô tả
400INVALID_INPUTPhần thân hoặc tham số yêu cầu không hợp lệ
401UNAUTHORIZEDThiếu hoặc khóa API không hợp lệ
402INSUFFICIENT_CREDITSKhông đủ tín dụng cho thao tác
403FORBIDDENEmail chưa được xác minh
404NOT_FOUNDKhông tìm thấy tài nguyên
429RATE_LIMITEDQuá nhiều yêu cầu
500INTERNAL_ERRORLỗi máy chủ không mong muốn

Tín dụng & Giá cả#

Lập chỉ mục thường

1 tín dụng / URL

Xử lý tiêu chuẩn. URL được gửi đến Google để lập chỉ mục.

Lập chỉ mục tức thì

10 tín dụng / URL

Xử lý ưu tiên để có kết quả lập chỉ mục nhanh hơn.

Tín dụng không bao giờ hết hạn. Mỗi lần gửi có thể chứa từ 1 đến 1.000 URL. Các URL không hợp lệ sẽ bị lọc bỏ và không tiêu tốn tín dụng.

Gửi URL#

POST/api/v1/submit10 yêu cầu / 60s

Gửi một lô URL để lập chỉ mục Google.

Phần thân yêu cầu

Tham sốLoạiBắt buộcMô tả
urlsstring[]Bắt buộcMảng các URL cần lập chỉ mục (1–1.000)
indexingTypestringBắt buộc"normal" hoặc "instant"
projectIdstringTùy chọnLiên kết với một dự án
submissionNamestringTùy chọnTên tùy chỉnh cho lần gửi

Yêu cầu ví dụ

cURL
curl -X POST https://www.indexbolt.com/api/v1/submit \
  -H "Authorization: Bearer ib_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/page-1",
      "https://example.com/page-2"
    ],
    "indexingType": "normal"
  }'

Phản hồi — 201 Created

{
  "success": true,
  "data": {
    "submissionId": "sub_abc123",
    "totalUrls": 2,
    "creditsUsed": 2,
    "balanceAfter": 98,
    "invalidUrls": []
  }
}
Xác thực URL: URL phải sử dụng HTTP/HTTPS, dưới 2.048 ký tự và trỏ đến các địa chỉ công khai. Các IP riêng tư/nội bộ (localhost, 10.x.x.x, 192.168.x.x, v.v.) sẽ bị từ chối. Các URL trùng lặp sẽ tự động bị xóa.

Liệt kê các lần gửi#

GET/api/v1/submissions60 yêu cầu / 60s

Truy xuất danh sách phân trang các lần gửi của bạn.

Tham số truy vấn

Tham sốLoạiBắt buộcMô tả
pageintegerTùy chọnSố trang (mặc định: 1)
pageSizeintegerTùy chọnKết quả mỗi trang, tối đa 100 (mặc định: 20)
statusstringTùy chọn"queued", "processing", "completed", "partial_failure" hoặc "failed"

Yêu cầu ví dụ

cURL
curl https://www.indexbolt.com/api/v1/submissions?page=1&pageSize=10 \
  -H "Authorization: Bearer ib_your_api_key"

Phản hồi — 200 OK

{
  "success": true,
  "data": {
    "submissions": [
      {
        "id": "sub_abc123",
        "name": "Submission #1",
        "status": "completed",
        "indexingType": "normal",
        "totalUrls": 5,
        "creditsUsed": 5,
        "createdAt": "2025-01-15T10:30:00Z",
        "completedAt": "2025-01-15T11:45:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 45,
      "totalPages": 5
    }
  }
}

Lấy thông tin lần gửi#

GET/api/v1/submissions/:id60 yêu cầu / 60s

Lấy đầy đủ chi tiết của một lần gửi, bao gồm trạng thái của từng URL.

Tham số đường dẫn

Tham sốLoạiBắt buộcMô tả
idstringBắt buộcID lần gửi

Yêu cầu ví dụ

cURL
curl https://www.indexbolt.com/api/v1/submissions/sub_abc123 \
  -H "Authorization: Bearer ib_your_api_key"

Phản hồi — 200 OK

{
  "success": true,
  "data": {
    "id": "sub_abc123",
    "name": "Submission #1",
    "status": "completed",
    "indexingType": "normal",
    "totalUrls": 5,
    "creditsUsed": 5,
    "createdAt": "2025-01-15T10:30:00Z",
    "completedAt": "2025-01-15T11:45:00Z",
    "urls": [
      { "url": "https://example.com/page-1", "status": "completed" },
      { "url": "https://example.com/page-2", "status": "completed" }
    ]
  }
}

Kiểm tra số dư#

GET/api/v1/balance30 yêu cầu / 60s

Kiểm tra số dư tín dụng hiện tại của bạn.

Yêu cầu ví dụ

cURL
curl https://www.indexbolt.com/api/v1/balance \
  -H "Authorization: Bearer ib_your_api_key"

Phản hồi — 200 OK

{
  "success": true,
  "data": {
    "balance": 98,
    "unit": "credits"
  }
}

Sẵn sàng bắt đầu?

Tạo tài khoản, lấy khóa API và bắt đầu lập chỉ mục URL trong vài phút.

Bắt đầu miễn phíQuản lý khóa API