Ресурси за разработчици

Справочник на REST API

Интегрирайте масовата проверка на индексирането директно в собствените си табла, инструменти или скриптове. Автоматизирайте своя SEO процес с нашия високопроизводителен API.

Накратко

REST API на IndexChecker ви позволява от собствените ви скриптове и табла да създавате проекти за проверка, да четете статуса им на индексиране и да проверявате наличността на кредити. Всяка заявка се удостоверява с вашия таен API ключ в тялото на POST заявката, крайните точки връщат JSON, проектът приема до 50 000 URL, а 1 кредит проверява 1 URL.

Автор: Adam Piersa, основател на IndexChecker Прегледано и обновено през

Какви крайни точки има API на IndexChecker?

Крайна точкаМетодПредназначение
/api/project/createPOSTСъздаване на проект за проверка от списък с URL адреси
/api/project/showPOSTПолучаване на статуса, статистиката и връзките на проект
/api/project/show_allPOSTСписък с всички ваши проекти
/api/project/deletePOSTОкончателно изтриване на проект
/api/check-balancePOSTПроверка на текущата наличност на кредити

Удостоверяване

Удостоверявайте заявките, като включите своя таен API ключ в тялото на заявката (POST параметри).

Можете да намерите и управлявате своя API ключ в настройките на панела.

Предупреждение за сигурност: Пазете API ключа си на сигурно място. Не го споделяйте в публично достъпен код (напр. клиентски JS).


POST

Създаване на проект

Създайте нов проект за проверка със списък от URL адреси.

https://app.indexchecker.link/api/project/create
apikey задължително string

Вашият таен API ключ.

project_name задължително string

Името на проекта ви.

urls задължително string

Списък с URL адреси, разделени с вертикална черта |.

description по избор string
Пример с 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"
Отговор 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

Подробности за проекта

Получете статуса, статистиката и връзките на конкретен проект.

https://app.indexchecker.link/api/project/show
apikey задължително
project_id задължително int

ID на проекта, който искате да получите.

Отговор 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
  }
}
* Кодове на статуса: 1 (индексиран), 0 (не е индексиран), -1 (проверката предстои)

POST

Списък с всички проекти

Получете списък с всички ваши проекти.

https://app.indexchecker.link/api/project/show_all
apikey задължително
Отговор
{
  "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

Изтриване на проект

Окончателно премахнете проект и всички свързани с него данни.

https://app.indexchecker.link/api/project/delete
apikey задължително
project_id задължително

ID на проекта за изтриване.

Отговор
{
  "id": "154",
  "error": 0,
  "message": "The MyProject project has been deleted"
}

POST

Проверка на наличността

Получете текущия си лимит на кредити.

https://app.indexchecker.link/api/check-balance
apikey задължително
Отговор 200 OK
{
  "limit": 4500,
  "error": 0
}

Често задавани въпроси

Как да удостоверявам API заявките?

Включете своя таен API ключ като параметър apikey в тялото на POST заявката. Ключа намирате и управлявате в настройките на панела.

Колко URL адреса може да има един проект в API?

До 50 000 URL адреса на проект, същият лимит като в панела. При създаване на проект ги разделете с вертикална черта в параметъра urls.

Колко струва проверка чрез API?

1 кредит за проверен URL, включително повторната проверка във втория център за данни. Кредитите никога не изтичат, а достъпът до API е включен във всеки пакет, от безплатния пробен нагоре.

В какъв формат отговаря API?

В JSON. Всяка крайна точка връща поле error, което е 0 при успех, плюс данните на проекта: статус, статистика и, когато е приложимо, резултат от индексирането за всеки URL.

IndexChecker е инструмент за масова проверка на индексирането в Google, управляван от AP2Media Sp. z o.o., регистрирана в ЕС компания със седалище в Czerwin, Полша (ДДС номер PL7582396091). Използва се в реална среда в собствените SEO проекти на компанията, включително услугата за локално SEO drukujemy3d.pl, и през последните 30 дни е проверил над два милиона URL адреса за своите клиенти.

Източници и препратки

Официалната документация на Google за това как работи индексирането и как да го проверите.