API Документація

Вступ

Опис

SEOlib API забезпечує доступ до технічних можливостей сервісу. Ви можете використовувати API для більш гнучкої роботи з проектами, звітами, позиціями, а також для використання сервісу без веб-інтерфейсу.

З чого почати

Як користуватися API:

Зареєструватися
Підтвердити реєстрацію.
Отримати токен API.

Як отримати API токен:

Увійти
Перейти до параметрів облікового запису.
Вибрати вкладку "Параметри API".
Натисніть кнопку "Створити ключ".

Можливості

Аккаунт:
1. Баланс користувача
Загальне:
1. Список пошукових систем
2. Список регіонів пошуку
Проекти:
1. Список проектів
2. Параметри проекту
  1. Пошукові системи проекту
  2. Регіони пошуку проекту
3. Звіти по проекту:
  1. Звіт по позиціям
  2. Звіт по ТОП(ам)
Метрики:
1. Перевірка позицій:
  1. Створити завдання
  2. Отримати результат
2. Перевірка ТОП(а):
  1. Створити завдання
  2. Отримати результат
Помилки:
1. Коди помилок

Аккаунт

Баланс користувача

Опис

Метод для отримання поточного балансу користувача з урахуванням заблокованих коштів

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/account/balance	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача

Приклад запиту

{
	"token": "<string>"
}

Відповідь сервера

Назва		Тип	Опис
success		boolean	Повертає true у разі успіху або false у разі помилки
content		array	Повертає масив з результатом запиту або повідомлення про помилку
	balance	float	Поточний баланс користувача з урахуванням заблокованих коштів
	currency	string	Валюта у форматі ISO 4217

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"balance": "<float>",
		"currency": "<string>"
	}
}

Загальне

Список пошукових систем

Опис

Метод поверне список активних пошукових систем

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/globals/engines	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача

Приклад запиту

{
	"token": "<string>"
}

Відповідь сервера

Назва			Тип	Опис
success			boolean	Повертає true у разі успіху або false у разі помилки
content			array	Повертає масив з результатом запиту або повідомлення про помилку
	engines		array	Список активних пошукових систем
		id	numeric	Ідентифікатор пошукової системи
		name	string	Назва пошукової системи
		depths	array	Допустима глибина пошуку
		prices	array	Вартість перевірки для обраної глибини

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"engines": [{
			"id": "<numeric>",
			"name": "<string>",
			"depths": [
				"<numeric>"
			],
			"prices": [
				"<array>"
			]
		}]
	}
}

Список регіонів пошуку

Опис

Метод поверне список активних регіонів пошуку

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/globals/regions	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
engine	numeric	Так	Ідентифікатор пошукової системи

Приклад запиту

{
	"token": "<string>",
	"engine": "<numeric>"
}

Відповідь сервера

Назва			Тип	Опис
success			boolean	Повертає true у разі успіху або false у разі помилки
content			array	Повертає масив з результатом запиту або повідомлення про помилку
	regions		array	Список активних регіонів пошуку
		id	numeric	Ідентифікатор регіону пошуку
		name	string	Назва регіону пошуку

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"regions": [{
			"id": "<numeric>",
			"name": "<string>"
		}]
	}
}

Проекти

Список проектів

Опис

Метод поверне список проектів

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/projects/list	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача

Приклад запиту

{
	"token": "<string>"
}

Відповідь сервера

Назва				Тип	Опис
success				boolean	Повертає true у разі успіху або false у разі помилки
content				array	Повертає масив з результатом запиту або повідомлення про помилку
	projects			array	Список проектів
		id		numeric	Ідентифікатор проекту
		name		string	Назва проекту
		domain		string	Адреса сайту
		group		array	Інформація про групу
			id	numeric	Ідентифікатор групи
			name	string	Назва групи
		keywords		array	Інформація про запити
			count	numeric	Кількість запитів
		active		boolean	Статус проекту

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"projects": [{
			"id": "<numeric>",
			"name": "<string>",
			"domain": "<string>",
			"group": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"keywords": {
				"count": "<numeric>"
			},
			"active": "<boolean>"
		}]
	}
}

Параметри проекту

Опис

Методи параметрів проекту

Пошукові системи проекту

Опис

Метод поверне список пошукових систем проекту

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/projects/settings/engines	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
project	numeric	Так	Ідентифікатор проекту

Приклад запиту

{
	"token": "<string>",
	"project": "<numeric>"
}

Відповідь сервера

Назва				Тип	Опис
success				boolean	Повертає true у разі успіху або false у разі помилки
content				array	Повертає масив з результатом запиту або повідомлення про помилку
	engines			array	Список пошукових систем
		engine		array	Інформація про пошукову систему
			id	numeric	Ідентифікатор пошукової системи
			name	string	Назва пошукової системи
		active		boolean	Статус пошукової системи

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"engines": [{
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"active": "<boolean>"
		}]
	}
}

Регіони пошуку проекту

Опис

Метод поверне список регіонів пошуку проекту

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/projects/settings/engines/regions	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
project	numeric	Так	Ідентифікатор проекту
engine	numeric	Так	Ідентифікатор пошукової системи

Приклад запиту

{
	"token": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>"
}

Відповідь сервера

Назва				Тип	Опис
success				boolean	Повертає true у разі успіху або false у разі помилки
content				array	Повертає масив з результатом запиту або повідомлення про помилку
	regions			array	Список регіонів пошуку
		region		array	Інформація про регіон
			id	numeric	Ідентифікатор регіону
			name	string	Назва регіону
		active		boolean	Статус регіону

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"regions": [{
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"active": "<boolean>"
		}]
	}
}

Звіти по проекту

Опис

Методи звітів щодо проекту

Звіт по позиціям

Опис

Метод поверне звіт щодо позицій проекту

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/projects/reports/positions	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
project	numeric	Так	Ідентифікатор проекту
engine	numeric	Так	Ідентифікатор пошукової системи
region	numeric	Так	Ідентифікатор регіону пошуку
period	array	Так	Період перевірки проекту у форматі ISO 8601

Приклад запиту

{
	"token": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>",
	"region": "<numeric>",
	"period": [
		"<YYYY-MM-DD/YYYY-MM-DD>" // "<YYYY-MM-DD>", "<YYYY-MM-DD>", ...
	]
}

Відповідь сервера

Назва				Тип	Опис
success				boolean	Повертає true у разі успіху або false у разі помилки
content				array	Повертає масив з результатом запиту або повідомлення про помилку
	reports			array	Список регіонів пошуку
		created		array	Дата та час перевірки
			date	string	Дата і час
			timezone_type	string	Тип часового поясу
			timezone	string	Назва часового поясу
		project		array	Інформація про проект
			id	numeric	Ідентифікатор проекту
			name	string	Назва проекту
		engine		array	Інформація про пошукову систему
			id	numeric	Ідентифікатор пошукової системи
			name	string	Назва пошукової системи
		region		array	Інформація про регіон пошуку
			id	numeric	Ідентифікатор регіону
			name	string	Назва регіону
		group		array	Інформація про групу ключового запиту
			id	numeric	Ідентифікатор групи ключового запиту
			name	string	Назва групи ключового запиту
			sort	numeric	Порядковий номер групи ключового запиту
		keyword		array	Інформація про ключовий запит
			id	numeric	Ідентифікатор ключового запиту
			name	string	Назва ключового запиту
			sort	numeric	Порядковий номер ключового запиту
		data		array	Дані щодо перевірки
			position	numeric	Позиція сайту
			page	string	Сторінка сайту

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"reports": [{
			"created": {
				"date": "<string>",
				"timezone_type": "<string>",
				"timezone": "<string>"
			},
			"project": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"group": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"keyword": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"data": {
				"position": "<numeric>",
				"page": "<string>"
			}
		}]
	}
}

Звіт по ТОП(ам)

Опис

Метод поверне звіт з топ(ам) проекту

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/projects/reports/tops	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
project	numeric	Так	Ідентифікатор проекту
engine	numeric	Так	Ідентифікатор пошукової системи
region	numeric	Так	Ідентифікатор регіону пошуку
period	array	Так	Період перевірки проекту у форматі ISO 8601

Приклад запиту

{
	"token": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>",
	"region": "<numeric>",
	"period": [
		"<YYYY-MM-DD/YYYY-MM-DD>" // "<YYYY-MM-DD>", "<YYYY-MM-DD>", ...
	]
}

Відповідь сервера

Назва				Тип	Опис
success				boolean	Повертає true у разі успіху або false у разі помилки
content				array	Повертає масив з результатом запиту або повідомлення про помилку
	reports			array	Список регіонів пошуку
		created		array	Дата та час перевірки
			date	string	Дата і час
			timezone_type	string	Тип часового поясу
			timezone	string	Назва часового поясу
		project		array	Інформація про проект
			id	numeric	Ідентифікатор проекту
			name	string	Назва проекту
		engine		array	Інформація про пошукову систему
			id	numeric	Ідентифікатор пошукової системи
			name	string	Назва пошукової системи
		region		array	Інформація про регіон пошуку
			id	numeric	Ідентифікатор регіону
			name	string	Назва регіону
		group		array	Інформація про групу ключового запиту
			id	numeric	Ідентифікатор групи ключового запиту
			name	string	Назва групи ключового запиту
			sort	numeric	Порядковий номер групи ключового запиту
		keyword		array	Інформація про ключовий запит
			id	numeric	Ідентифікатор ключового запиту
			name	string	Назва ключового запиту
			sort	numeric	Порядковий номер ключового запиту
		data		array	Дані щодо перевірки
			position	numeric	Позиція сайту
			page	string	Сторінка сайту

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"reports": [{
			"created": {
				"date": "<string>",
				"timezone_type": "<string>",
				"timezone": "<string>"
			},
			"project": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"group": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"keyword": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"data": {
				"position": "<numeric>",
				"page": "<string>"
			}
		}]
	}
}

Метрики

Перевірка позицій

Опис

Методи перевірки позицій

Створити завдання

Опис

Метод створює відкладене завдання на перевірку позицій та повертає ідентифікатор

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/positions/task/create	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва		Тип	Обов'язково	Опис
token		string	Так	Токен авторизації користувача
domain		string	Так	Адреса сайту
keywords		array	Так	Ключові запити для перевірки
engines		array	Так	Пошукові системи та регіони пошуку
	engine	numeric	Так	Ідентифікатор пошукової системи
	regions	array	Так	Ідентифікатор регіону пошуку
	depth	numeric	Так	Глибина пошуку

Приклад запиту

{
	"token": "<string>",
	"domain": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>",
		"depth": "<numeric>"
	}]
}

Відповідь сервера

Назва		Тип	Опис
success		boolean	Повертає true у разі успіху або false у разі помилки
content		array	Повертає масив з результатом запиту або повідомлення про помилку
	task	string	Токен завдання для отримання результатів

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Отримати результат

Опис

Метод повертає результат відкладеного завдання

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/positions/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
task	string	Так	Токен завдання для отримання результатів

Приклад запиту

{
	"token": "<string>",
	"task": "<string>"
}

Відповідь сервера

Назва						Тип	Опис
success						boolean	Повертає true у разі успіху або false у разі помилки
content						array	Повертає масив з результатом запиту або повідомлення про помилку
	status					boolean	Повертає true у разі готовності завдання або false якщо завдання ще у роботі
	result					array	Повертає масив із результатом виконаного завдання
		keyword				string	Ключовий запит
		engines				array	Пошукові системи
			engine			numeric	Ідентифікатор пошукової системи
			regions			array	Регіони пошуку
				region		numeric	Ідентифікатор регіону пошуку
				report		array	Звіт за результатами пошуку
					total	array	Загальна кількість знайдених результатів пошуковою системою
					pages	array	Усі знайдені сторінки, що ранжуються, на сторінці пошуку
					page	string	Сторінка, що ранжується на сторінці пошуку для вказаної адреси сайту
					position	numeric	Позиція вказаної адреси сайту на сторінці пошуку
					snippet	string	Сніппет вказаної адреси сайту на сторінці пошуку

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"total": "<array>",
						"page": "<array>",
						"position": "<array>",
						"snippet": "<array>"
					}
				}
			}
		}]
	}
}

Перевірка ТОП(а)

Опис

Методи перевірки ТОП(а)

Створити завдання

Опис

Метод створює відкладене завдання на перевірку ТОП(а) та повертає ідентифікатор

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/tops/task/create	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва		Тип	Обов'язково	Опис
token		string	Так	Токен авторизації користувача
keywords		array	Так	Ключові запити для перевірки
engines		array	Так	Пошукові системи та регіони пошуку
	engine	numeric	Так	Ідентифікатор пошукової системи
	regions	array	Так	Ідентифікатор регіону пошуку
	depth	numeric	Так	Глибина пошуку

Приклад запиту

{
	"token": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>",
		"depth": "<numeric>"
	}]
}

Відповідь сервера

Назва		Тип	Опис
success		boolean	Повертає true у разі успіху або false у разі помилки
content		array	Повертає масив з результатом запиту або повідомлення про помилку
	task	string	Токен завдання для отримання результатів

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Отримати результат

Опис

Метод повертає результат відкладеного завдання

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/tops/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
task	string	Так	Токен завдання для отримання результатів

Приклад запиту

{
	"token": "<string>",
	"task": "<string>"
}

Відповідь сервера

Назва						Тип	Опис
success						boolean	Повертає true у разі успіху або false у разі помилки
content						array	Повертає масив з результатом запиту або повідомлення про помилку
	status					boolean	Повертає true у разі готовності завдання або false якщо завдання ще у роботі
	result					array	Повертає масив із результатом виконаного завдання
		keyword				string	Ключовий запит
		engines				array	Пошукові системи
			engine			numeric	Ідентифікатор пошукової системи
			regions			array	Регіони пошуку
				region		numeric	Ідентифікатор регіону пошуку
				report		array	Звіт за результатами пошуку
					total	array	Загальна кількість знайдених результатів пошуковою системою
					pages	array	Усі знайдені сторінки, що ранжуються, на сторінці пошуку

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"total": "<array>",
						"pages": "<array>"
					}
				}
			}
		}]
	}
}

Перевірка частоти

Опис

Методи перевірки частоти

Створити завдання

Опис

Метод створює відкладене завдання на перевірку частоти та повертає ідентифікатор

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/frequency/task/create	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва		Тип	Обов'язково	Опис
token		string	Так	Токен авторизації користувача
keywords		array	Так	Ключові запити для перевірки
engines		array	Так	Пошукові системи та регіони пошуку
	engine	numeric	Так	Ідентифікатор пошукової системи
	regions	array	Так	Ідентифікатор регіону пошуку
type		array	Так	Тип відповідності
	1	numeric	Так	Широка відповідність
	2	numeric	Так	Широке з точною словоформою
	3	numeric	Так	Фразова відповідність
	4	numeric	Так	Фразове з точною словоформою
more		array	Ні	Додатково
	1	numeric	Ні	Підібрати схожі запити

Приклад запиту

{
	"token": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>"
	}],
	"type": [
		"<numeric>"
	],
	"more": [
		"<numeric>"
	]
}

Відповідь сервера

Назва		Тип	Опис
success		boolean	Повертає true у разі успіху або false у разі помилки
content		array	Повертає масив з результатом запиту або повідомлення про помилку
	task	string	Токен завдання для отримання результатів

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Отримати результат

Опис

Метод повертає результат відкладеного завдання

Запит

URL

Адреса методу	Метод запиту	Формат запиту
https://api.seolib.ru/metrics/frequency/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Опис
Content-Type	application/json	Запит у форматі JSON

Параметри

Запит до сервера

Назва	Тип	Обов'язково	Опис
token	string	Так	Токен авторизації користувача
task	string	Так	Токен завдання для отримання результатів

Приклад запиту

{
	"token": "<string>",
	"task": "<string>"
}

Відповідь сервера

Назва						Тип	Опис
success						boolean	Повертає true у разі успіху або false у разі помилки
content						array	Повертає масив з результатом запиту або повідомлення про помилку
	status					boolean	Повертає true у разі готовності завдання або false якщо завдання ще у роботі
	result					array	Повертає масив із результатом виконаного завдання
		keyword				string	Ключовий запит
		phrases				array	Схожі запити
		engines				array	Пошукові системи
			engine			numeric	Ідентифікатор пошукової системи
			regions			array	Регіони пошуку
				region		numeric	Ідентифікатор регіону пошуку
				report		array	Звіт за результатами пошуку
					1	numeric	Широка відповідність
					2	numeric	Широке з точною словоформою
					3	numeric	Фразова відповідність
					4	numeric	Фразове з точною словоформою

Приклад відповіді

{
	"success": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"phrases": [
				"<string>"
			],
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"1": "<numeric>",
						"2": "<numeric>",
						"3": "<numeric>",
						"4": "<numeric>"
					}
				}
			}
		}]
	}
}

Помилки

Коди помилок

Опис

Список всіх помилок

Коди

Приклад відповіді

{
	"success": "<boolean>",
	"content": [
		"<string>"
	]
}