Balik sa home

API Documentation

REST API ng Instant Index PH — bersyon 1

Mabilisang simula

1. Kumuha ng key

Available sa lahat ng plano, nasa Dashboard → Profile → API Access.

2. Ipadala ang mga URL mo

Isang POST sa submission endpoint. Hanggang 500 URL kada request, pinoproseso nang tig-tatlo.

3. Subaybayan ang pag-crawl

Ipinapakita ng history kung nasaan na ang bawat URL. Itinatago ito nang 48 oras.

Authentication

Hinihintay ng mga naka-authenticate na endpoint ang key mo sa header na Authorization: Bearer. Nagsisimula ang mga key sa ixfil_ at nagagawa ang mga ito sa Dashboard → Profile → API Access.

# Ang API key mo ang nag-a-authenticate sa bawat request
curl https://instantindexph.com/api/user/credits \
  -H "Authorization: Bearer ixfil_ANG_API_KEY_MO"

Katumbas ng password mo ang key mo: huwag mo itong ilagay sa code na ipinapadala sa browser, sa isang pampublikong repository, o sa loob ng isang URL. Kung tumagas ito, gumawa ng bago mula sa dashboard — titigil agad sa paggana ang luma.

Mga limitasyon

500

URL kada request

3 URL

Laki ng batch

48 oras

Tagal ng history

10 req/s

Rate limit

Endpoints

POST/api/indexing/submitKailangan ng key

Magsumite ng mga URL

Nagpapadala ng hanggang 500 URL sa Google. Nilalagay sila sa queue at pinoproseso nang tig-tatlo.

Laman ng request

{
  "urls": [
    "https://sitemo.ph/page-1",
    "https://sitemo.ph/page-2",
    "https://sitemo.ph/page-3"
  ]
}

Sagot

{
  "success": true,
  "submitted": 3,
  "failed": 0,
  "creditsUsed": 3,
  "remainingCredits": 61,
  "results": [
    { "url": "https://sitemo.ph/page-1", "status": "submitted" },
    { "url": "https://sitemo.ph/page-2", "status": "submitted" },
    { "url": "https://sitemo.ph/page-3", "status": "submitted" }
  ]
}

Mga error

  • 400Walang binigay na valid na URL
  • 402Kulang ang credits
  • 429Sobrang dami ng request — bagalan mo
  • 503Hindi available ang indexing service
GET/api/indexing/history?page=1&limit=20Kailangan ng key

Tingnan ang history

Kinukuha ang mga submission mo, naka-page. Itinatago ang mga URL nang 48 oras.

Sagot

{
  "submissions": [
    {
      "_id": "abc123",
      "url": "https://sitemo.ph/page-1",
      "status": "submitted",
      "searchEngine": "google",
      "creditsUsed": 1,
      "createdAt": "2026-09-07T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

Mga error

  • 401Walang API key o hindi valid
GET/api/user/creditsKailangan ng key

Tingnan ang balance mo

Ibinabalik ang balance ng credits mo, ang plano mo, at ang halaga ng isang submission.

Sagot

{
  "credits": 80,
  "planName": "Starter",
  "planExpiresAt": "2099-12-31T00:00:00Z",
  "creditCosts": { "credit_cost_url_indexing": 1 }
}

Mga error

  • 401Walang API key o hindi valid
GET/api/plansPampubliko

Ilista ang mga plano

Ibinabalik ang lahat ng aktibong plano. Walang kailangang authentication.

Sagot

{
  "plans": [
    {
      "name": "Starter",
      "price": 5,
      "credits": 80,
      "currency": "USD",
      "billingPeriod": "lifetime",
      "features": ["80 credits para sa indexing", "…"]
    }
  ]
}

May tanong tungkol sa API? Sulatan mo kami, sumasagot kami sa loob ng 24 oras.