Resursi za developere

Referenca REST API-ja

Integrirajte skupnu provjeru indeksiranja izravno u vlastite upravljačke ploče, alate ili skripte. Automatizirajte svoj SEO postupak našim API-jem visokog kapaciteta.

Ukratko

REST API IndexCheckera omogućuje vam da iz vlastitih skripti i upravljačkih ploča izrađujete projekte provjere, čitate njihov status indeksiranja i provjeravate stanje kredita. Svaki zahtjev autentificira se vašim tajnim API ključem u tijelu POST zahtjeva, endpointi vraćaju JSON, projekt prima do 50.000 URL-ova, a 1 kredit provjerava 1 URL.

Autor: Adam Piersa, osnivač IndexCheckera Pregledano i ažurirano

Koje endpointe ima API IndexCheckera?

EndpointMetodaNamjena
/api/project/createPOSTIzrada projekta provjere iz popisa URL-ova
/api/project/showPOSTDohvat statusa, statistike i poveznica projekta
/api/project/show_allPOSTPopis svih vaših projekata
/api/project/deletePOSTTrajno brisanje projekta
/api/check-balancePOSTOčitavanje trenutačnog stanja kredita

Autentifikacija

Autentificirajte zahtjeve tako da u tijelo zahtjeva (POST parametri) uključite svoj tajni API ključ.

Svoj API ključ pronaći ćete i njime upravljati u postavkama upravljačke ploče.

Sigurnosno upozorenje: Čuvajte svoj API ključ na sigurnom. Ne dijelite ga u javno dostupnom kodu (npr. JS na strani klijenta).


POST

Izrada projekta

Izradite novi projekt provjere s popisom URL-ova.

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

Vaš tajni API ključ.

project_name obavezno string

Naziv vašeg projekta.

urls obavezno string

Popis URL-ova odvojenih okomitom crtom |.

description neobavezno string
Primjer 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"
Odgovor 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

Detalji projekta

Dohvatite status, statistiku i poveznice određenog projekta.

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

ID projekta koji želite dohvatiti.

Odgovor 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
  }
}
* Statusni kodovi: 1 (indeksirano), 0 (nije indeksirano), -1 (provjera na čekanju)

POST

Popis svih projekata

Dohvatite popis svih svojih projekata.

https://app.indexchecker.link/api/project/show_all
apikey obavezno
Odgovor
{
  "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

Brisanje projekta

Trajno uklonite projekt i sve povezane podatke.

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

ID projekta koji želite obrisati.

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

POST

Provjera stanja

Dohvatite svoje trenutačno ograničenje kredita.

https://app.indexchecker.link/api/check-balance
apikey obavezno
Odgovor 200 OK
{
  "limit": 4500,
  "error": 0
}

Česta pitanja

Kako autentificirati API zahtjeve?

Uključite svoj tajni API ključ kao parametar apikey u tijelo POST zahtjeva. Ključ ćete pronaći i promijeniti u postavkama upravljačke ploče.

Koliko URL-ova može imati jedan projekt putem API-ja?

Do 50.000 URL-ova po projektu, isto ograničenje kao na upravljačkoj ploči. Pri izradi projekta odvojite ih okomitom crtom u parametru urls.

Koliko stoji provjera putem API-ja?

1 kredit po provjerenom URL-u, uključujući ponovnu provjeru u drugom podatkovnom centru. Krediti nikad ne istječu, a pristup API-ju uključen je u svaki paket, od besplatne probe naviše.

U kojem formatu API odgovara?

U JSON-u. Svaki endpoint vraća polje error, koje je 0 pri uspjehu, te podatke o projektu: status, statistiku i, gdje je primjenjivo, rezultat indeksiranja po URL-u.

IndexChecker je alat za skupnu provjeru indeksiranja u Googleu kojim upravlja AP2Media Sp. z o.o., tvrtka registrirana u EU sa sjedištem u Czerwinu u Poljskoj (PDV ID PL7582396091). Koristi se u produkciji na vlastitim SEO projektima tvrtke, uključujući uslugu lokalnog SEO-a drukujemy3d.pl, a u posljednjih 30 dana provjerio je više od dva milijuna URL-ova za svoje korisnike.