все функции возращают данные в таком формате:
{
"successful": true, // true если запрос обработан успешно, false если ошибка
"data": {}, // данные
"message": "" // текст ошибки
}
- Тип запроса - get
- Параметры:
- email - адрес электронной почты
- password - пароль
- Метод регистрации пользователя
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"c": "a77347fd9734" // код сессии
}
}
- Тип запроса - get
- Параметры:
- email - адрес электронной почты
- password - пароль
- Метод авторизации пользователя
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"c": "a77347fd9734" // код сессии
}
}
- Тип запроса - get
- Параметры:
- c - код сессиии
- Метод выхода пользователя из аккаунта
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- Метод получения списка проектов
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": [
{
"id": 1,
"userId": 1,
"siteAddress": "yandex.ru",
"searchEngine": "yandex,google",
"searchingRange": "100",
"parsingTime": "12:00:00",
"parsingDays": "Monday,Tuesday,Thursday",
"queriesCount": 0,
"lastCollection": "2022-07-14T08:32:52.232Z"
},
{
"id": 2,
"userId": 1,
"siteAddress": "pozishen.ru",
"searchEngine": "yandex",
"searchingRange": "200",
"parsingTime": "12:00:00",
"parsingDays": "Tuesday,Thursday",
"queriesCount": 10,
"lastCollection": "2022-07-14T08:32:52.232Z"
}
]
}
- Тип запроса - get
- Параметры:
- s - код восстановления
- password - новый пароль
- Метод смены пароля после его восстановления
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"c": "a77347fd9734" // код сессии
}
}
- Тип запроса - get
- Параметры:
- email - электронная почта для восстановления
- Метод получения письма содержащий ссылку на восстановление пароля
- В случае успеха возращает ответ в виде и отправляет письмо с ссылкой на восстановление на указаный адрес:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- currentPassword - текущий пароль
- newPassword - новый пароль
- Метод смены пароля
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- Метод получения информации об пользователе
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"email": "[email protected]",
"balance": 10,
"executedTasksForDay": 0,
"executedTasksForWeek": 0,
"executedTasksForMonth": 0,
"discount": 0,
"maxResourceLimit": 10,
"loadLimit": 80,
"accountCreatedAt": "2022-07-05T11:16:19.000Z"
}
}
- Тип запроса - get
- Параметры:
- c - код сессии
- ссылка на скачивание клиента
- Тип запроса - get
- Параметры:
- c - код сессии
- queryText - текст запроса
- groupId - айди группы
- projectId - айди проекта
- Метод добавления запроса
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"queryText": '',
"groupId": 1
}
}
- Тип запроса - get
- Параметры:
- c - код сессии
- name - имя группы
- projectId - айди проекта
- Метод добавления группы
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"projectId": 1,
"groupName": '',
"queriesCount": 0
}
}
- Тип запроса - get
- Параметры:
- c - код сессии
- groupId - айди группы
- projectId - айди проекта
- queryId - айди запроса
- Метод удаления запроса
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- groupId - айди группы
- projectId - айди проекта
- Метод удаления группы
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- groupId - айди группы
- projectId - айди проекта
- p - необязательный по умолчанию = 0, страница, в каждой странице 25 запросов
- Получить список запросов
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": [
{
"id": 1,
"queryText": '',
"groupId": 1
},
{
"id": 2,
"queryText": '',
"groupId": 1
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- projectId - айди проекта
- Метод получения групп
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": [
{
"id": 1,
"projectId": 1,
"groupName": '',
"queriesCount": 0
},
{
"id": 2,
"projectId": 1,
"groupName": '',
"queriesCount": 10
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- projectId - айди проекта
- Метод получения проекта по его id
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"userId": 1,
"siteAddress": "yandex.ru",
"searchEngine": "yandex,google",
"searchingRange": "100",
"parsingTime": "12:00:00",
"parsingDays": "Monday,Tuesday,Thursday",
"queriesCount": 0,
"lastCollection": "2022-07-14T08:32:52.232Z"
}
}
- Тип запроса - get
- Параметры:
- c - код сессии
- p - номер страницы по умолчанию = 0
- groupId - айди группы, 0 = все группы
- engine - поисковик yandex/google
- from - дата с
- to - дата до
- projectId - айди проекта
- Метод для получения позиций
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data":
[
{
"id": 1,
"queryId": 1,
"queryText": "",
"groupId": 1,
"projectId": 1,
"place": 1,
// 0 - не найдено
"lastCollection": '2022-07-14T08:32:52.232Z',
"cityCollection": "Москва",
"engineCollection": 'yandex',
"foundAddress": "https://yandex.ru/example"// найденный юрл с искомым доменом
}
]
}
- Тип запроса - post
- Тело запроса:
{
"c": "2324fafc",
"project": {
"siteAddress": "pozishen.ru",
"searchEngine": ["yandex"],
"searchingRange": "100",
"parsingTime": "12:00",
"parsingDays": ["Monday", "Thursday"],
"cities": [
"Москва", "Санкт-Петербург"
]
}
}
- Метод добавления проекта
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"userId": 1,
"siteAddress": "yandex.ru",
"searchEngine": "yandex,google",
"searchingRange": "100",
"parsingTime": "12:00:00",
"parsingDays": "Monday,Tuesday,Thursday",
"queriesCount": 0,
"lastCollection": "2022-07-14T08:32:52.232Z"
}
}
- Тип запроса - post
- Тело запроса:
{
"c": "2324fafc",
"projectId": 1,
"project": {
"siteAddress": "pozishen.ru",
"searchEngine": ["yandex"],
"searchingRange": "100",
"parsingTime": "12:00",
"parsingDays": ["Monday", "Thursday"],
"cities": [
"Москва", "Санкт-Петербург"
]
}
}
- Метод обновления настроек проекта
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"userId": 1,
"siteAddress": "yandex.ru",
"searchEngine": "yandex,google",
"searchingRange": "100",
"parsingTime": "12:00:00",
"parsingDays": "Monday,Tuesday,Thursday",
"queriesCount": 0,
"lastCollection": "2022-07-14T08:32:52.232Z"
}
}
- Тип запроса - get
- Параметры:
- c - код сессии
- loadLimit - лимит общей нагрузки системы
- maxResourceLimit - максимальное использование ресурсов
- Метод обновления настроек программы
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- groupId - айди группы
- projectId - айди проекта
- Метод получения колличества запросов
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": 0
}
- Тип запроса - get
- Параметры:
- c - код сессии
- projectId - айди проекта
- Получить города проекта
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data":
[
{
"id": 1,
"projectId": 1,
"cityName": "Москва"
},
{
"id": 2,
"projectId": 1,
"cityName": "Санкт-Петербург"
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- groupId - айди группы, 0 = все группы
- engine - поисковик yandex/google
- from - дата с
- to - дата до
- projectId - айди проекта
- Метод получения колличества позиций
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": 0
}
- Тип запроса - get
- Параметры:
- c - код сессии
- p - номер страницы по умолчанию = 0
- queryId - айди запроса
- engine - поисковик yandex/google
- from - дата с
- to - дата до
- projectId - айди проекта
- Метод получения позиций для определенного запроса
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data":
[
{
"id": 1,
"queryId": 1,
"queryText": "",
"groupId": 1,
"projectId": 1,
"place": 1, // 0 - не найдено
"lastCollection": '2022-07-14T08:32:52.232Z',
"cityCollection": "Москва",
"engineCollection": 'yandex',
"foundAddress": "https://yandex.ru/example" // найденный юрл с искомым доменом
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- p - номер страницы по умолчанию = 0
- from - дата с
- to - дата до
- Метод получения расходов
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data":
[
{
"id": 1,
"userId": 1,
"date": "",
"projectId": 1,
"expense": "0.8"
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- from - дата с
- to - дата до
- Метод получения колличества расходов
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": 0
}
- Тип запроса - get
- Параметры:
- c - код сессии
- search - поиск
- count - колличество
- Метод поиска городов по поисковому запросу
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": [
{
"name": "Москва",
}
]
}
- Тип запроса - get
- Параметры:
- c - код сессии
- projectId - айди проекта
- Метод для начала ручного сбора позиций
- В случае успеха возращает ответ в виде:
{
"successful": true
}
- Тип запроса - get
- Параметры:
- c - код сессии
- queryId - айди запроса
- engine - поисковик yandex/google
- projectId - айди проекта
- groupId - айди группы по умолчанию 0 - все группы
- Метод для получения первой и последней позиции
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"first": {
"id": 34,
"queryId": 1,
"queryText": "",
"groupId": 1,
"projectId": 1,
"place": 1, // 0 - не найдено
"lastCollection": '2022-07-14T08:32:52.232Z',
"cityCollection": "Москва",
"engineCollection": 'yandex',
"foundAddress": "https://yandex.ru/example" // найденный юрл с искомым доменом
},
"last": {
"id": 1,
"queryId": 1,
"queryText": "",
"groupId": 1,
"projectId": 1,
"place": 1, // 0 - не найдено
"lastCollection": '2022-07-01T08:32:52.232Z',
"cityCollection": "Москва",
"engineCollection": 'yandex',
"foundAddress": "https://yandex.ru/example" // найденный юрл с искомым доменом
}
}
}
- Тип запроса - get
- Параметры:
- p - программный хэш
- Метод получения настроек программы
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"loadLimit": 80,
"maxResourceLimit": 10
}
}
- Тип запроса - get
- Параметры:
- p - программный хэш
- Метод получения задачи, если задач нет то возращает сообщение "Нет доступных задач"
- В случае успеха возращает ответ в виде:
{
"successful": true,
"data": {
"id": 1,
"projectId": 1,
"groupId": 1,
"queryId": 1,
"queryText": "",
"city": "Москва",
"searchingEngine": "yandex",
"searchingRange": "100",
"parsingTime": "12:00",
"siteAddress": "pozishen.ru"
}
}
- По истечению 10 минут задачу завершить нельзя
- Тип запроса - get
- Параметры:
- p - программный хэш
- place - место в поисковой выдаче, если не найдено то 0
- taskId - айди задачи
- foundAddress - адрес найденного сайта с искомым доменом, например
https://pozishen.ru/example/test
- Метод завершения задачи
- В случае успеха возращает ответ в виде:
{
"successful": true
}