Web Service API

Оглавление:

1. Описание
2. Методы API
   • Работа со справочниками
     • Person
     • Site
     • Keyword
   • Получение статистики

Описание

Веб-сервис транслирует запросы от Мобильного и Десктопного интерфейсов пользователя в SQL запросы к базе данных. Результат, полученный от запроса, передает обратно Мобильному и Десктопному интерфейсу. Сервис включает в себя запросы для работы со справочниками Person, Site и Keyword и для запроса статистики.

Методы API

Работа со справочниками

Person

Тип запроса/ссылка	Описание
[[GET /person	show-persons]]
[[GET /person/{id}	show-person]]
[[POST /person	add-person]]
[[PUT /person	update-person]]
[[DELETE /person/{id}	delete-person]]

Site

Тип запроса/ссылка	Описание
[[GET /site	show-sites]]
[[GET /site/{id}	show-site]]
[[POST /site	add-site]]
[[PUT /site	update-site]]
[[DELETE /site/{id}	delete-site]]

Keyword

Тип запроса/ссылка	Описание
[[GET /keyword/{person_id}/	show-keywords]]
[[GET /keyword/{id}	show-keyword]]
[[POST /keyword/{person_id}	add-keyword]]
[[PUT /keyword/{id}	update-keyword]]
[[DELETE /keyword/{id}	delete-keyword]]

Получение статистики

Тип запроса/ссылка	Описание
[[GET /stat/{site_id}}	show-all-site-stat]]
[[GET /stat/{site_id; person_id}	show-person-rank]]
[[GET /stat/{site_id; person_id; date_from; date_to}	show-new-pages]]
[[GET /stat/{site_id; person_id; date}	show-new-pages]]
[[GET /stat/{site_id; person_id; date_from; date_to}	show-all-dates]]