Referensi API

Dokumentasi API Pengindeksan URL

API pengindeksan URL IndexBolt memungkinkan Anda mengirim URL ke Google untuk pengindeksan, melacak progres pengiriman, dan mengelola kredit secara terprogram. Integrasikan pengindeksan URL massal ke dalam alur kerja SEO, plugin WordPress, atau alat khusus Anda.

Base URL: https://www.indexbolt.com/api/v1Permintaan & respons JSONAutentikasi token bearer

Autentikasi#

Semua permintaan API memerlukan token Bearer di header Authorization. Buat kunci API dari pengaturan dasbor Anda.

Contoh header permintaan
Authorization: Bearer ib_your_api_key_here
Penting: Kunci API diawali dengan prefiks ib_. Jaga kerahasiaan kunci Anda — jangan paparkan dalam kode sisi klien. Anda dapat membuat hingga 5 kunci API per akun.

Batas Laju#

Batas laju diterapkan per kunci API menggunakan sliding window. Saat dibatasi laju, Anda akan menerima kode status 429.

EndpointBatasWindow
POST /submit10 permintaan60 detik
GET /balance30 permintaan60 detik
GET /submissions, /submissions/:id60 permintaan60 detik

Header respons X-RateLimit-Remaining dan X-RateLimit-Reset menunjukkan penggunaan Anda saat ini.

Penanganan Kesalahan#

Semua kesalahan mengembalikan struktur JSON yang konsisten:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}
Status HTTPKodeDeskripsi
400INVALID_INPUTIsi atau parameter permintaan tidak valid
401UNAUTHORIZEDKunci API hilang atau tidak valid
402INSUFFICIENT_CREDITSKredit tidak cukup untuk operasi
403FORBIDDENEmail belum diverifikasi
404NOT_FOUNDSumber daya tidak ditemukan
429RATE_LIMITEDTerlalu banyak permintaan
500INTERNAL_ERRORKesalahan server tak terduga

Kredit & Harga#

Pengindeksan Normal

1 kredit / URL

Pemrosesan standar. URL dikirim ke Google untuk pengindeksan.

Pengindeksan Instan

10 kredit / URL

Pemrosesan prioritas untuk hasil pengindeksan yang lebih cepat.

Kredit tidak pernah kedaluwarsa. Setiap pengiriman dapat berisi antara 1 dan 1.000 URL. URL tidak valid disaring dan tidak mengonsumsi kredit.

Kirim URL#

POST/api/v1/submit10 permintaan / 60 dtk

Kirim batch URL untuk pengindeksan Google.

Isi Permintaan

ParameterTipeWajibDeskripsi
urlsstring[]WajibArray URL untuk diindeks (1–1.000)
indexingTypestringWajib"normal" atau "instant"
projectIdstringOpsionalKaitkan dengan proyek
submissionNamestringOpsionalNama khusus untuk pengiriman

Contoh Permintaan

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

Respons — 201 Created

{
  "success": true,
  "data": {
    "submissionId": "sub_abc123",
    "totalUrls": 2,
    "creditsUsed": 2,
    "balanceAfter": 98,
    "invalidUrls": []
  }
}
Validasi URL: URL harus menggunakan HTTP/HTTPS, di bawah 2.048 karakter, dan menunjuk ke alamat publik. IP privat/internal (localhost, 10.x.x.x, 192.168.x.x, dll.) ditolak. URL duplikat otomatis dihapus.

Daftar Pengiriman#

GET/api/v1/submissions60 permintaan / 60 dtk

Ambil daftar pengiriman Anda yang dipaginasi.

Parameter Kueri

ParameterTipeWajibDeskripsi
pageintegerOpsionalNomor halaman (default: 1)
pageSizeintegerOpsionalHasil per halaman, maks 100 (default: 20)
statusstringOpsional"queued", "processing", "completed", "partial_failure", atau "failed"

Contoh Permintaan

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

Respons — 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
    }
  }
}

Dapatkan Pengiriman#

GET/api/v1/submissions/:id60 permintaan / 60 dtk

Dapatkan detail lengkap pengiriman, termasuk status per URL.

Parameter Jalur

ParameterTipeWajibDeskripsi
idstringWajibID pengiriman

Contoh Permintaan

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

Respons — 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" }
    ]
  }
}

Periksa Saldo#

GET/api/v1/balance30 permintaan / 60 dtk

Periksa saldo kredit Anda saat ini.

Contoh Permintaan

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

Respons — 200 OK

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

Siap memulai?

Buat akun, ambil kunci API Anda, dan mulai mengindeks URL dalam hitungan menit.