Fejlesztői források

REST API referencia

Építse be a tömeges indexelés-ellenőrzést közvetlenül saját irányítópultjaiba, eszközeibe vagy szkriptjeibe. Automatizálja SEO-folyamatát nagy áteresztőképességű API-nkkal.

Röviden

Az IndexChecker REST API-jával saját szkriptjeiből és irányítópultjairól hozhat létre ellenőrzési projekteket, olvashatja ki azok indexelési állapotát, és ellenőrizheti kreditegyenlegét. Minden kérést a titkos API-kulcsa hitelesít a POST törzsben, a végpontok JSON-t adnak vissza, egy projekt akár 50 000 URL-t is fogad, és 1 kredit 1 URL-t ellenőriz.

Szerző: Adam Piersa, az IndexChecker alapítója Átnézve és frissítve:

Milyen végpontjai vannak az IndexChecker API-nak?

VégpontMódszerRendeltetés
/api/project/createPOSTEllenőrzési projekt létrehozása URL-listából
/api/project/showPOSTEgy projekt állapotának, statisztikáinak és linkjeinek lekérése
/api/project/show_allPOSTAz összes projekt listázása
/api/project/deletePOSTProjekt végleges törlése
/api/check-balancePOSTAz aktuális kreditegyenleg lekérdezése

Hitelesítés

A kéréseket úgy hitelesítse, hogy a titkos API-kulcsát a kérés törzsébe (POST paraméterek) helyezi.

API-kulcsát az irányítópult beállításaiban találja és kezelheti.

Biztonsági figyelmeztetés: Őrizze biztonságban az API-kulcsát. Ne ossza meg nyilvánosan elérhető kódban (például ügyféloldali JS-ben).


POST

Projekt létrehozása

Új ellenőrzési projekt létrehozása URL-listával.

https://app.indexchecker.link/api/project/create
apikey kötelező string

A titkos API-kulcsa.

project_name kötelező string

A projekt neve.

urls kötelező string

Függőleges vonallal | elválasztott URL-lista.

description nem kötelező string
cURL példa 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"
Válasz 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

Projekt részleteinek lekérése

Egy adott projekt állapotának, statisztikáinak és linkjeinek lekérése.

https://app.indexchecker.link/api/project/show
apikey kötelező
project_id kötelező int

A lekérni kívánt projekt azonosítója.

Válasz 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
  }
}
* Állapotkódok: 1 (indexelve), 0 (nincs indexelve), -1 (ellenőrzés folyamatban)

POST

Összes projekt listázása

Az összes projekt listájának lekérése.

https://app.indexchecker.link/api/project/show_all
apikey kötelező
Válasz
{
  "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

Projekt törlése

Egy projekt és az összes kapcsolódó adat végleges eltávolítása.

https://app.indexchecker.link/api/project/delete
apikey kötelező
project_id kötelező

A törlendő projekt azonosítója.

Válasz
{
  "id": "154",
  "error": 0,
  "message": "The MyProject project has been deleted"
}

POST

Egyenleg ellenőrzése

Az aktuális kreditkeret lekérdezése.

https://app.indexchecker.link/api/check-balance
apikey kötelező
Válasz 200 OK
{
  "limit": 4500,
  "error": 0
}

Gyakori kérdések

Hogyan hitelesíthetem az API-kéréseket?

Minden kérés POST törzsében adja meg titkos API-kulcsát apikey paraméterként. A kulcsot az irányítópult beállításaiban találja és kezelheti.

Hány URL lehet egy API-projektben?

Projektenként legfeljebb 50 000 URL, ugyanannyi, mint az irányítópulton. Projekt létrehozásakor függőleges vonallal válassza el őket az urls paraméterben.

Mennyibe kerül egy API-n keresztüli ellenőrzés?

Ellenőrzött URL-enként 1 kredit, a második adatközpontos újraellenőrzéssel együtt. A kreditek soha nem járnak le, és az API-hozzáférés minden csomagban benne van, az ingyenes próbaverziótól kezdve.

Milyen formátumban válaszol az API?

JSON-ban. Minden végpont visszaad egy error mezőt, amely sikeres kérésnél 0, valamint a projekt adatait: állapotot, statisztikát és adott esetben URL-enkénti indexelési eredményt.

Az IndexChecker egy tömeges Google-indexelés-ellenőrző, amelyet az AP2Media Sp. z o.o. üzemeltet, egy EU-ban bejegyzett, a lengyelországi Czerwinben székelő vállalat (közösségi adószám: PL7582396091). A vállalat saját SEO-projektjeiben éles üzemben használják, köztük a drukujemy3d.pl helyi SEO-szolgáltatásban, és az elmúlt 30 napban több mint kétmillió URL-t ellenőrzött ügyfelei számára.