Спецификация api сайта seumka ru



Скачать 103.05 Kb.
Дата20.10.2012
Размер103.05 Kb.
ТипДокументы

Спецификация API сайта seumka.ru.


Все запросы идут на url: "index.php?option=com_seumka&controller=manager&task=taskname", с помощью POST, дополнительные параметры передаются через JSON, где taskname – один из:

1. authuser


Аутентификация.

json:

{

"username": "string",

"password": "string"

}

username – логин,

password – пароль.

response:

{

"status": "boolean",

"message": "string"

}

status – true – успех, false – неудача,

message – в случае неудачи аутентификации возвращает сообщение об ошибке.

Дополнительно устанавливается cookie, который необходимо посылать вместе со всеми последующими запросами.

2. deauthuser


Деаутентификация.

json:

{}

response:

{

"status": "boolean"

}

status – true – успех, false – неудача.

Дополнительно удаляется аутентификационный cookie.

3. listsites


Получить список сайтов.

json:

{}

response:

{

"status": "boolean",

"message": "",

"sites": array of {

"siteid": "integer",

"url": "string"

}

}

status – true – успех, false – неудача,

message – в случае неудачи возвращает сообщение об ошибке,

sites – массив сайтов, где:

siteid – id сайта,

url – URL сайта.

4. getphrasesjson


Получить список фраз для одного сайта.

json:

{

"siteid": "integer",

"act": "boolean",

"hash": "string",

"type": "integer"

}

Где:

siteid – id сайта.

act: true – только активные фразы, false – все (в данной реализации – игнорируется).

hash: Хэш, для гостевого доступа (если пуст – игнорируется).

type: -3 – сравнить 2-е даты (игнорируется).

response: array of {

"phraseid": "integer",

"phrase": "string"

}

phraseid – id фразы,

phrase – фраза.

5. listses


Получить список поисковиков.


json:

{}

response:

{

"status": "boolean",

"message": "string",

"searchengines": array of {

"searchengineid": "integer",

"searchengine": "string"

}

}

status – true – успех, false – неудача,

message – в случае неудачи возвращает сообщение об ошибке,

searchengines – массив поисковиков, где:

searchengineid – id поисковика,

searchengine – наименование поисковика.

6. getposjson2


Получить список позиций в поисковиках для одного сайта и нескольких фраз за определённый период.

json:

{

"siteid": "integer",

"phraseids": array of "integer",

"dtf": "string",

"dtt": "string",

"seid": array of "integer",

"dates": array of "string",

"hash": "string",

"type": "integer"

}

siteid – id сайта,

phraseids – массив id фраз,

dtf – дата начала периода (формат: "dd.mm.yyyy")

dtt – дата конца периода,

seid – id, или массив id поисковых систем,

dates – массив дат, внутри периода, включая границы (в случае сравнения 2-х дат – эти две даты), при пропуске дат возникнет ошибка,

hash – хэш для гостевого доступа, или пустая строка,

type – тип запроса, -3 для сравнения 2-х дат, иначе – игнорируется.

response:

{

"p": array of {

"d": array of {

"s": array of {

"v": "integer"

}

}

}

}

p – массив, индекс массива – id фразы,

d – массив, индекс массива – дата (формат: "dd-mm-yyyy"),

s – массив, индекс массива – id поисковика,

v – позиция данной фразы в данном поисковике за данный день (>0 – фраза была опрошена, и найдена на этой позиции, ==0 – фраза была опрошена, но не найдена в выдаче, -1 – фраза опрошена не была).

7. geturlsjson


Получить список URL, на которых был найден сайт по нескольким фразам в определённый день.

json:

{

"siteid": "integer",

"phraseids": array of "integer",

"date": "string",

"seid": "integer",

"hash": "string",

}

siteid – id сайта,

phraseids – массив id фраз,

date – дата (формат: "dd.mm.yyyy")

seid – id, поисковой системы,

hash – хэш для гостевого доступа, или пустая строка.

response: array of {

"phraseid": "integer",

"phraseurl": "string"

}

phraseid – id фразы,

phraseurl – URL, без URL сайта (e. g. "/content/view/70/57/"), или пустая строка если фраза не опрашивалась, или не найдена.

8. getyamastatsjson


Получить статистику поисковых запросов для сайта по нескольким ключевым фразам за определённую дату.

json:

{

"siteid": "integer",

"phraseids": array of "integer",

"date": "string",

"yastat": "boolean",

"mastat": "boolean",

"hash": "string"

}

siteid – id сайта,

phraseids – массив id фраз,

date – дата (формат: "dd.mm.yyyy"),

yastat – true, если нужна статистика с wordstat.yandex.ru

mastat – true, если нужна статистика с stat.go.mail.ru

hash – хэш для гостевого доступа, или пустая строка.

response: array of {

"phraseid": "integer",

"yap": "integer",

"map": "integer"

}

phraseid – id фразы,

yap – данные с wordstat.yandex.ru, если yastat == true, иначе поле отсутствует,

map – данные с stat.go.mail.ru, если mastat == true, иначе поле отсутствует.

9. changeseforsite


Включить/выключить опрос сайта в поисковой системе.

Параметры передаются просто через POST, а не через JSON.

post:

{

"enabled": "boolean",

"seid": "integer",

"siteid": "integer"

}

enabled – true – включить опрос, false – выключить опрос,

seid – id поисковика,

siteid – id сайта.

Ничего не возвращает.

10. saveyareg

Сохранение региона яндеска для сайта.

json:

{

"siteid": "integer",

"yareg": "integer",

"seid": "integer"

}

seid – id поисковика,

yareg – id региона (берётся из Яндекса),

siteid – id сайта.

11. saveyastat


Включить/выключить сбор статистики wordstat.yandex.ru.

json:

{

"siteid": "integer",

"yastat": "boolean"

}

siteid – id сайта,

yastat – true – включить сбор статистики, false – выключить.

response: [true]

12. savemastat


Включить/выключить сбор статистики stat.go.mail.ru.

json:

{

"siteid": "integer",

"mastat": "boolean"

}

siteid – id сайта,

mastat – true – включить сбор статистики, false – выключить.

response: [true]

13. disablesite


Выключить опрос сайта.

Параметры передаются просто через POST, а не через JSON.

post:

{

"siteid": "integer"

}

siteid – id сайта.

14. enablesite


Включить опрос сайта.

Параметры передаются просто через POST, а не через JSON.

post:

{

"siteid": "integer"

}

siteid – id сайта.

15. disablephrase


Параметры передаются просто через POST, а не через JSON.

post:

{

"siteid": "integer"

"phraseid": "integer"

}

siteid – id сайта,

phraseid – id фразы.

16. enablephrase


Параметры передаются просто через POST, а не через JSON.

{

"siteid": "integer"

"phraseid": "integer"

}

siteid – id сайта,

phraseid – id фразы.

17. addsitehash

Добавить ссылку для гостевого доступа к отчёту (до 3-х штук).

json:

{

"siteid": "integer"

}

siteid – id сайта.

response: array of {

"hash": "string"

}

hash – хэш для гостевого доступа.

18. delsitehash


Удалить ссылку для гостевого доступа к отчёту.

json:

{

"hash": "string"

}

hash – хэш для гостевого доступа.

Ничего не возвращает.

19. setcommentjson

Добавить/удалить примечание к ячейке таблицы отчёта.

json:

{

"siteid": "integer",

"phraseid": "integer",

"seid": "integer",

"dt": "string",

"comment": "string"

}

siteid – id сайта,

phraseid – id фразы,

seid – id поисковой системы,

dt – дата (формат "dd.mm.yyyy"),

comment – строка комментария (если пустая строка – удаляет комментарий)

response:

{

"c": "integer"

"t": "string"

}

c – 1 – есть комментарий, 0 – иначе.

t – если с == 1 – строка с комментарием.

20. getcommentjson

Получить установленные комментарии для фраз текущего сайта за определённый период.

json:

{

"siteid": "integer",

"phraseids": array of "integer",

"seid": "integer",

"dtf": "string",

"dtt": "string"

}

siteid – id сайта,

phraseid – массив id фраз,

seid – id поисковой системы,

dtf – дата начала интервала (формат "dd.mm.yyyy"),

dtt – дата конца интервала (формат "dd.mm.yyyy").

response:

{

"phraseid-date": {

"c": "integer",

"t": "string",

"d": "string",

"i": "integer"

}

}

phrase

Похожие:

Спецификация api сайта seumka ru iconСпецификация команд api в Кругу Друзей 10. 04. 2012

Спецификация api сайта seumka ru iconИнтерфейс прикладного программирования
Программные компоненты взаимодействуют друг с другом посредством api. При этом обычно компоненты образуют иерархию — высокоуровневые...
Спецификация api сайта seumka ru iconСпецификация moReq
Данная спецификация подготовлена Cornwell Management Consultants plc
Спецификация api сайта seumka ru iconЛабораторная работа №1 Функции Win32 api для работы с файлами Лабораторный практикум Математический факультет
Создать приложение, в котором работа с файлами и каталогами организована через системные вызовы (функции Win32 api)
Спецификация api сайта seumka ru iconУстав. Конституция. Закон. Правила. Alania23 Имя сайта. Имя сайта
Имя сайта «Alania23» – является неприкосновенным и может использоваться только с разрешения администрации, руководства или владельцев...
Спецификация api сайта seumka ru iconОбщее описание сайта Содержание сайта На сайте отражается «своя» и «импортируемая»
Цель: привести внешний вид и функционал сайта в соответствие требованиям
Спецификация api сайта seumka ru iconОбщее описание сайта Содержание сайта На сайте отражается «своя» и «импортируемая»
Цель: привести внешний вид и функционал сайта в соответствие требованиям
Спецификация api сайта seumka ru iconБриф на разработку Веб-сайта Клиент: журнал «Досуг Moscow»
Пожелания к дизайну сайта: цветовая схема сайта должна быть выдержана в 4-х цветах
Спецификация api сайта seumka ru iconПользовательское Соглашение функциональности api сервиса Яндекс. Директ. Настоящее Соглашение регулирует отношения между Вами далее – «Вы» или «Пользователь»
Настоящее Соглашение регулирует отношения между Вами (далее – «Вы» или «Пользователь») и ООО «яндекс» (далее — «Яндекс») касательно...
Спецификация api сайта seumka ru iconМодель Спецификация Выкуп
Общая спецификация: Внешняя ткань-Polyester 600, основная молния 5, на кармане молния 5
Разместите кнопку на своём сайте:
ru.convdocs.org


База данных защищена авторским правом ©ru.convdocs.org 2016
обратиться к администрации
ru.convdocs.org