Reference REST API
Integrujte hromadnou kontrolu indexace přímo do vlastních panelů, nástrojů nebo skriptů. Zautomatizujte svůj SEO workflow s naším vysokovýkonným API.
REST API IndexCheckeru vám umožní vytvářet kontrolní projekty, číst jejich stav indexace a zjišťovat zůstatek kreditů z vlastních skriptů a panelů. Každý požadavek se ověřuje vaším tajným API klíčem v těle POST, endpointy vracejí JSON, projekt přijme až 50 000 adres a 1 kredit zkontroluje 1 adresu.
Jaké endpointy má API IndexCheckeru?
| Endpoint | Metoda | Účel |
|---|---|---|
| /api/project/create | POST | Vytvořit kontrolní projekt ze seznamu adres |
| /api/project/show | POST | Získat stav, statistiky a odkazy projektu |
| /api/project/show_all | POST | Vypsat všechny vaše projekty |
| /api/project/delete | POST | Trvale smazat projekt |
| /api/check-balance | POST | Zjistit aktuální zůstatek kreditů |
Začínáme
Ověřování
Ověřte své požadavky tak, že do těla požadavku (parametry POST) přidáte svůj tajný API klíč.
Svůj API klíč najdete a spravujete v nastavení panelu.
Bezpečnostní upozornění: Uchovejte svůj API klíč v bezpečí. Nesdílejte jej ve veřejně přístupném kódu (např. v JS na straně klienta).
Vytvořit projekt
Vytvořit nový kontrolní projekt se seznamem adres.
Váš tajný API klíč.
Název vašeho projektu.
Seznam adres oddělených svislou čarou |.
-d "apikey=YOUR_API_KEY" \
-d "project_name=MyProject" \
-d "urls=https://site1.com|https://site2.com"
"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
}
Získat detaily projektu
Získat stav, statistiky a odkazy konkrétního projektu.
ID projektu, který chcete načíst.
"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
}
}
Vypsat všechny projekty
Získat seznam všech vašich projektů.
"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"
}
}
Smazat projekt
Trvale odstranit projekt a všechna související data.
ID projektu ke smazání.
"id": "154",
"error": 0,
"message": "The MyProject project has been deleted"
}
Zkontrolovat zůstatek
Zjistit svůj aktuální limit kreditů.
"limit": 4500,
"error": 0
}
Často kladené otázky
Jak ověřovat požadavky API?
Přidejte svůj tajný klíč API jako parametr apikey do těla požadavku POST. Klíč najdete a změníte v nastavení panelu.
Kolik adres může mít jeden projekt přes API?
Až 50 000 adres na projekt, stejně jako v panelu. Při vytváření projektu je oddělíte svislou čarou v parametru urls.
Kolik stojí kontrola přes API?
1 kredit za zkontrolovanou adresu, včetně opětovné kontroly v druhém datovém centru. Kredity nevyprší a přístup k API je v každém balíčku, od bezplatné zkušební verze výše.
V jakém formátu API odpovídá?
V JSON. Každý endpoint vrací pole error, které je při úspěchu 0, plus data projektu - stav, statistiky a případně výsledek indexace pro jednotlivé adresy.
IndexChecker je hromadný nástroj na kontrolu indexace v Google, provozovaný společností AP2Media Sp. z o.o., firmou registrovanou v EU se sídlem v Czerwinu v Polsku (DIČ PL7582396091). Používá se v ostrém provozu na vlastních SEO projektech společnosti, včetně služby lokálního SEO drukujemy3d.pl, a za posledních 30 dní ověřil pro své zákazníky více než dva miliony adres.
Oficiální dokumentace Google o tom, jak indexace funguje a jak ji zkontrolovat.