Dokumentacja REST API
Wbuduj masowe sprawdzanie indeksacji wprost we własne dashboardy, narzędzia i skrypty. Zautomatyzuj swój proces SEO dzięki naszemu wydajnemu API.
REST API IndexCheckera pozwala tworzyć projekty sprawdzania, odczytywać ich status indeksacji i sprawdzać saldo kredytów z własnych skryptów i dashboardów. Każde żądanie uwierzytelniasz tajnym kluczem API w treści POST, endpointy zwracają JSON, projekt przyjmuje do 50 000 adresów, a 1 kredyt to 1 sprawdzenie URL.
Jakie endpointy ma API IndexCheckera?
| Endpoint | Metoda | Cel |
|---|---|---|
| /api/project/create | POST | Utwórz projekt sprawdzania z listy adresów |
| /api/project/show | POST | Pobierz status, statystyki i linki projektu |
| /api/project/show_all | POST | Wyświetl listę wszystkich projektów |
| /api/project/delete | POST | Trwale usuń projekt |
| /api/check-balance | POST | Odczytaj aktualne saldo kredytów |
Wprowadzenie
Konto
Uwierzytelnianie
Uwierzytelniaj żądania, dołączając swój tajny klucz API w treści żądania (parametry POST).
Swój klucz API znajdziesz i zmienisz w ustawieniach panelu.
Ostrzeżenie bezpieczeństwa: Trzymaj swój klucz API w bezpiecznym miejscu. Nie umieszczaj go w publicznie dostępnym kodzie (np. w JS po stronie przeglądarki).
Utwórz projekt
Utwórz nowy projekt sprawdzania z listą adresów URL.
Twój tajny klucz API.
Nazwa Twojego projektu.
Lista adresów URL oddzielonych symbolem potoku |.
-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
}
Pobierz szczegóły projektu
Pobierz status, statystyki i linki konkretnego projektu.
ID projektu, który chcesz pobrać.
"project_name": "MyProject",
"description": "opcjonalne 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
}
}
Lista wszystkich projektów
Pobierz listę wszystkich swoich projektów.
"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"
}
}
Usuń projekt
Trwale usuń projekt i wszystkie powiązane dane.
ID projektu do usunięcia.
"id": "154",
"error": 0,
"message": "The MyProject project has been deleted"
}
Sprawdź saldo
Sprawdź swój aktualny limit kredytów.
"limit": 4500,
"error": 0
}
Najczęściej zadawane pytania
Jak uwierzytelniać żądania API?
Dołącz swój tajny klucz API jako parametr apikey w treści żądania POST. Klucz znajdziesz i zmienisz w ustawieniach panelu.
Ile adresów może mieć jeden projekt w API?
Do 50 000 adresów na projekt, tak samo jak w panelu. Rozdzielasz je symbolem potoku w parametrze urls przy tworzeniu projektu.
Ile kosztuje sprawdzenie przez API?
1 kredyt za sprawdzony adres, razem z ponownym sprawdzeniem w drugim centrum danych. Kredyty nie tracą ważności, a dostęp do API jest w każdym pakiecie, od darmowego triala wzwyż.
W jakim formacie odpowiada API?
W JSON. Każdy endpoint zwraca pole error, które przy powodzeniu ma wartość 0, plus dane projektu - status, statystyki i wynik indeksacji per adres, gdy dotyczy.
IndexChecker to narzędzie do masowego sprawdzania indeksacji w Google, prowadzone przez AP2Media Sp. z o.o., zarejestrowaną w UE spółkę z siedzibą w Czerwinie (NIP PL7582396091). Jest używane produkcyjnie we własnych projektach SEO firmy, w tym w usłudze lokalnego SEO drukujemy3d.pl, i w ostatnich 30 dniach zweryfikowało dla klientów ponad dwa miliony adresów URL.
Oficjalna dokumentacja Google o tym, jak działa indeksowanie i jak je sprawdzać.