Zdroje pre vývojárov

Referencia REST API

Integrujte hromadnú kontrolu indexácie priamo do vlastných panelov, nástrojov alebo skriptov. Automatizujte svoj SEO postup s naším výkonným API.

V skratke

REST API IndexCheckeru vám umožní vytvárať kontrolné projekty, čítať ich stav indexácie a zisťovať zostatok kreditov z vlastných skriptov a panelov. Každá požiadavka sa overuje vaším tajným API kľúčom v tele POST, endpointy vracajú JSON, projekt prijme až 50 000 URL a 1 kredit skontroluje 1 URL.

Autor: Adam Piersa, zakladateľ IndexCheckeru Skontrolované a aktualizované

Aké endpointy má API IndexCheckeru?

EndpointMetódaÚčel
/api/project/createPOSTVytvoriť kontrolný projekt zo zoznamu URL
/api/project/showPOSTZískať stav, štatistiky a odkazy projektu
/api/project/show_allPOSTVypísať všetky vaše projekty
/api/project/deletePOSTNatrvalo zmazať projekt
/api/check-balancePOSTZistiť aktuálny zostatok kreditov

Overenie

Požiadavky overte tak, že do tela požiadavky (parametre POST) pridáte svoj tajný API kľúč.

Svoj API kľúč nájdete a spravujete v nastaveniach panela.

Bezpečnostné upozornenie: Uchovávajte svoj API kľúč v bezpečí. Nezdieľajte ho vo verejne dostupnom kóde (napr. v JS na strane klienta).


POST

Vytvoriť projekt

Vytvorte nový kontrolný projekt so zoznamom URL.

https://app.indexchecker.link/api/project/create
apikey povinné string

Váš tajný API kľúč.

project_name povinné string

Názov vášho projektu.

urls povinné string

Zoznam URL oddelených zvislou čiarou |.

description voliteľné string
Príklad cURL POST
curl -X POST https://app.indexchecker.link/api/project/create \
  -d "apikey=YOUR_API_KEY" \
  -d "project_name=MyProject" \
  -d "urls=https://site1.com|https://site2.com"
Odpoveď 200 OK
{
  "error": 0,
  "message": "project MyProject has been added in it 2 links.",
  "project_name": "MyProject",
  "procjet_id": 154,
  "project_id": 154,
  "add_links_count": 2
}

POST

Získať detaily projektu

Získajte stav, štatistiky a odkazy konkrétneho projektu.

https://app.indexchecker.link/api/project/show
apikey povinné
project_id povinné int

ID projektu, ktorý chcete načítať.

Odpoveď 200 OK
{
  "project_name": "MyProject",
  "description": "optional description",
  "date_created": "2023-10-12 14:30:00",
  "project_id": "154",
  "urls": {
    "https://site1.com": "1",
    "https://site2.com": "-1"
  },
  "statistics": {
    "total_links": 2,
    "indexed": 1,
    "not_indexed": 0,
    "pending": 1,
    "percentage": 50
  }
}
* Stavové kódy: 1 (indexované), 0 (neindexované), -1 (kontrola čaká)

POST

Vypísať všetky projekty

Získajte zoznam všetkých svojich projektov.

https://app.indexchecker.link/api/project/show_all
apikey povinné
Odpoveď
{
  "154": {
    "project_name": "MyProject",
    "description": "",
    "date_created": "2023-10-12 14:30:00"
  },
  "155": {
    "project_name": "Another Project",
    "description": "SEO Audit",
    "date_created": "2023-10-13 09:15:00"
  }
}

POST

Zmazať projekt

Natrvalo odstráňte projekt a všetky súvisiace údaje.

https://app.indexchecker.link/api/project/delete
apikey povinné
project_id povinné

ID projektu na zmazanie.

Odpoveď
{
  "id": "154",
  "error": 0,
  "message": "The MyProject project has been deleted"
}

POST

Skontrolovať zostatok

Zistite svoj aktuálny limit kreditov.

https://app.indexchecker.link/api/check-balance
apikey povinné
Odpoveď 200 OK
{
  "limit": 4500,
  "error": 0
}

Často kladené otázky

Ako overiť požiadavky API?

Pridajte svoj tajný API kľúč ako parameter apikey do tela POST každej požiadavky. Kľúč nájdete a zmeníte v nastaveniach panela.

Koľko URL môže mať jeden projekt cez API?

Až 50 000 URL na projekt, rovnako ako v paneli. Pri vytváraní projektu ich oddeľte zvislou čiarou v parametri urls.

Koľko stojí kontrola cez API?

1 kredit za skontrolovanú URL vrátane opätovnej kontroly v druhom dátovom centre. Kredity nikdy neexpirujú a prístup k API je v každom balíku, od bezplatnej skúšobnej verzie vyššie.

V akom formáte API odpovedá?

V JSON. Každý endpoint vracia pole error, ktoré je pri úspechu 0, a k tomu údaje projektu: stav, štatistiky a prípadne výsledok indexácie pre jednotlivé URL.

IndexChecker je hromadný nástroj na kontrolu indexácie v Google, ktorý prevádzkuje spoločnosť AP2Media Sp. z o.o., firma registrovaná v EÚ so sídlom v Czerwine v Poľsku (IČ DPH PL7582396091). Používa sa v ostrej prevádzke na vlastných SEO projektoch spoločnosti vrátane služby lokálneho SEO drukujemy3d.pl a za posledných 30 dní overil pre svojich zákazníkov viac ako dva milióny URL.