API documentation

/api/adverts

POST /api/adverts.{_format} #

Создание нового объявления

Documentation
Sandbox

Documentation

Создание нового объявления

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
description_short	string	true
description_full	string	false
video_url	string	false
graphics_module	string	true
price	string	false
rubric	int	true
city	int	true
issues	string	true
user_token	string	true
author_name	string	true
author_phone	string	true
show_bold	string	true
show_border	string	true
show_background	string	true
extended	string	true
image_tokens	string	true

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/affiliate/rubrics.{_format} #

Список дочерних рубрик партнерской программы

Documentation
Sandbox

Documentation

Список дочерних рубрик партнерской программы

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

rubric

Requirement	\d+
Description
Default

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/adverts/email/favorite.{_format} #

Отправляет выбранные объявления на почту

Documentation
Sandbox

Documentation

Отправляет выбранные объявления на почту

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

ids[]

Requirement	\d+
Description

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/favorites.{_format} #

Список Объявлений, добавленных в избранное

Documentation
Sandbox

Documentation

Список Объявлений, добавленных в избранное

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/my.{_format} #

Список объявлений пользователя.

Documentation
Sandbox

Documentation

Список объявлений пользователя. /api/adverts/my

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

ids[]

Requirement	\d+
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/search.{_format} #

Поиск по объявлениям.

Documentation
Sandbox

Documentation

Поиск по объявлениям.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

query

Requirement
Description	Поисковый запрос.

extended

Requirement	0\|1
Description	Расширенное объявление.

with_image

Requirement	0\|1
Description	Есть фотографии.

is_number

Requirement	0\|1
Description	Искать по номеру объявления. В query указывается номер объявления.

page

Requirement	\d+
Description	Страница.
Default	1

limit

Requirement	\d+
Description	Количество результатов на страницу.
Default	20

rubric

Requirement	\d+
Description	Id рубрики в которой осуществляется поиск.
Default

tag

Requirement
Description	Поиск по тегам (tag=zhilje)
Default

filter

Requirement
Description	Поиск по фильтрам (filter=Avtovokzal)
Default

affiliate

Requirement	0\|1
Description	Поиск по объявлениям партнерской сети
Default	0

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/search/rubrics.{_format} #

Список в рубрик, в которых были найдены объявления.

Documentation
Sandbox

Documentation

Список в рубрик, в которых были найдены объявления.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

query

Requirement
Description

extended

Requirement	0\|1
Description

with_image

Requirement	0\|1
Description

is_number

Requirement	0\|1
Description
Default	0

rubric

Requirement	\d+
Description
Default

tag

Requirement
Description
Default

filter

Requirement
Description
Default

depth

Requirement
Description
Default	3

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/{advert}.{_format} #

Объявление по ID. Пользователь видит только опубликованные объявления, либо свои

Documentation
Sandbox

Documentation

Объявление по ID. Пользователь видит только опубликованные объявления, либо свои

Requirements

Name	Requirement	Type	Description
advert	\d+
_format

Filters

Name

Information

user_token

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/adverts/{advert}.{_format} #

Редактирование объявления. Изменять можно только свои объявления, либо обладая правами администратора

Documentation
Sandbox

Documentation

Редактирование объявления. Изменять можно только свои объявления, либо обладая правами администратора /api/adverts/392522?description_short=text&rubric=118&issues%5B%5D%5Bid%5D=57&author_name=yyy&author_phone=123&city=1

Requirements

Name	Requirement	Type	Description
_format	json\|html
advert

Parameters

Parameter	Type	Required?
description_short	string	true
description_full	string	false
video_url	string	false
graphics_module	string	true
price	string	false
rubric	int	true
city	int	true
issues	string	true
user_token	string	true
author_name	string	true
author_phone	string	true
show_bold	string	true
show_border	string	true
show_background	string	true
extended	string	true
image_tokens	string	true

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/adverts/{advert}.{_format} #

Удаление объявления. Удалять можно только свои объявления, либо обладая правами администратора

Documentation
Sandbox

Documentation

Удаление объявления. Удалять можно только свои объявления, либо обладая правами администратора

Requirements

Name	Requirement	Type	Description
_format	json\|html
advert

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/adverts/{advert}/basket.{_format} #

Перемещает объявленеи в корзину.

Documentation
Sandbox

Documentation

Перемещает объявленеи в корзину.

Requirements

Name	Requirement	Type	Description
_format	json\|html
advert		Advert	id объявления

Parameters

Parameter	Type	Required?	Description
basket	0\|1	true	1 - переместитьв корзину, 0 - восстановить

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PATCH /api/adverts/{advert}/favorite.{_format} #

Добавить объявление в избранное

Documentation
Sandbox

Documentation

Добавить объявление в избранное

Requirements

Name	Requirement	Type	Description
_format	json\|html
advert

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PATCH /api/adverts/{advert}/unfavorite.{_format} #

Убрать объявление из избранного

Documentation
Sandbox

Documentation

Убрать объявление из избранного

Requirements

Name	Requirement	Type	Description
_format	json\|html
advert

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/feedback/{id}

GET /api/feedback/{id}.{_format} #

Сообщение с формы обратной связи

Documentation
Sandbox

Documentation

Сообщение с формы обратной связи

Requirements

Name	Requirement	Type	Description
id
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/feedback/{id}/collection.{_format} #

Создание нового сообщения с формы обратной связи

Documentation
Sandbox

Documentation

Создание нового сообщения с формы обратной связи

Requirements

Name	Requirement	Type	Description
id
_format

Parameters

Parameter	Type	Required?
description_short	string	true
description_full	string	false
video_url	string	false
graphics_module	string	true
price	string	false
rubric	int	true
city	int	true
issues	string	true
user_token	string	true
author_name	string	true
author_phone	string	true
show_bold	string	true
show_border	string	true
show_background	string	true
extended	string	true
image_tokens	string	true

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/filters

GET /api/filters.{_format} #

Return Filters

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

type

Requirement	\d+
Description

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/filters.{_format} #

Create new filter

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Return

Parameter	Type	Versions	Description
meta_robots	array	*
meta_title	string	*
meta_keywords	string	*
meta_description	string	*
name	string	*	Имя узла
short_name	string	*	Краткое название

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/filters/{filter}.{_format} #

Return Filter by Id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
filter

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/filters/{filter}.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
filter

Return

Parameter	Type	Versions	Description
meta_robots	array	*
meta_title	string	*
meta_keywords	string	*
meta_description	string	*
name	string	*	Имя узла
short_name	string	*	Краткое название

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/filters/{filter}.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
filter

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/images

OPTIONS /api/images.{_format} #

Используется для определения возможностей веб-сервера или параметров соединения для конкретного ресурса.

Documentation
Sandbox

Documentation

Используется для определения возможностей веб-сервера или параметров соединения для конкретного ресурса. В ответ серверу следует включить заголовок Allow со списком поддерживаемых методов. Также в заголовке ответа может включаться информация о поддерживаемых расширениях.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/images.{_format} #

Загрузка изображения для объявлений. В случае успеха вовращается JSON.

Documentation
Sandbox

Documentation

Загрузка изображения для объявлений. В случае успеха вовращается JSON. На данный момент поддерживается загрузка только одного изображения

 {"files": [
     {
         "id": "1773",
         "name": "picture1.jpg",
         "size": 902604,
         "deleteUrl": "http:\/\/api.bkural.ru\/api\/images\/1773\/delete",
         "deleteType": "DELETE"
      }
 ]}

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
files[]		true
type	advert	true	Тип создаваемого изображения

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/images/create.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/images/{image}.{_format} #

Удалить изображение

Documentation
Sandbox

Documentation

Удалить изображение

Requirements

Name	Requirement	Type	Description
_format	json\|html
image

Status Codes

Status Code	Description
204	success

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/images/{image}/show.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
image

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/issues

GET /api/issues.{_format} #

Return Issues

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/issues.{_format} #

Create new issue

Documentation
Sandbox

Documentation

Создает новый выпуск

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
issue[number]		true
issue[publish_date]		true

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issues/advert_possible.{_format} #

Return advert_possible Issues

Documentation
Sandbox

Documentation

На странице редактирования объявления показываются выпуски: - только те прошедшие выпуски, в которых объявление было опубликовано, - текущий выпуск, - будущие выпуски - все, что созданы в админке.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

advert

Requirement	\d+
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issues/nearest.{_format} #

Выпуски, в которые можно подать объявление

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issues/{issue}.{_format} #

Return Issue by Id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
issue

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/issues/{issue}.{_format} #

Редактирование существующего выпуска

Documentation
Sandbox

Documentation

Редактирование существующего выпуска

Requirements

Name	Requirement	Type	Description
_format	json\|html
issue

Parameters

Parameter	Type	Required?	Description
issue[number]		true
issue[publish_date]		true

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/issues/{issue}.{_format} #

Удаляет существующее издание

Documentation
Sandbox

Documentation

Удаляет существующее издание

Requirements

Name	Requirement	Type	Description
_format	json\|html
issue

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issues/{issue}/pdf.{_format} #

Запросить файл pdf

Documentation
Sandbox

Documentation

Запросить файл pdf

Requirements

Name	Requirement	Type	Description
_format	json\|html
issue

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/messages

GET /api/messages.{_format} #

Список цепочек сообщений

Documentation
Sandbox

Documentation

Список цепочек сообщений. Цепочки показываются в обратном хронологическом порядке, по дате последнего сообщения.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/messages.{_format} #

Создание сообщения.

Documentation
Sandbox

Documentation

Создание сообщения.

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

Возможные ошибки

anonymous_advert

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
thread	int	true
advert	int	true
body	string	true

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/messages/read.{_format} #

Пометить сообщения как прочитанные.

Documentation
Sandbox

Documentation

Пометить сообщения как прочитанные.

Возможные ошибки

param_required

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
message_ids		true	Массив id сообщений

Status Codes

Status Code	Description
204	success

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/messages/search.{_format} #

Поиск по сообщениям.

Documentation
Sandbox

Documentation

Поиск по сообщениям.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

query

Requirement
Description	Поисковый запрос.

page

Requirement	\d+
Description	Страница.
Default	1

limit

Requirement	\d+
Description	Количество результатов на страницу.
Default	20

Status Codes

Status Code	Description
200	success

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/messages/{advert}/messages/advert.{_format} #

Сообщения для конкретного пользователя и конкретного объявления

Documentation
Sandbox

Documentation

Сообщения для конкретного пользователя и конкретного объявления

Requirements

Name	Requirement	Type	Description
advert	\d+
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Status Codes

Status Code	Description
200	success

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/messages/{thread}.{_format} #

Просмотр цепочки сообщений.

Documentation
Sandbox

Documentation

Просмотр цепочки сообщений.

Requirements

Name	Requirement	Type	Description
thread	\d+
_format	json\|html

Status Codes

Status Code	Description
200	success

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/messages/{thread}.{_format} #

Удалить цепочку.

Documentation
Sandbox

Documentation

Удалить цепочку.

Requirements

Name	Requirement	Type	Description
_format	json\|html
thread

Status Codes

Status Code	Description
204	success

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/messages/{thread}/messages.{_format} #

Сообщения из цепочки.

Documentation
Sandbox

Documentation

Сообщения из цепочки.

Requirements

Name	Requirement	Type	Description
thread	\d+
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Status Codes

Status Code	Description
200	success

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/orders

GET /api/orders.{_format} #

Return Orders

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

user_token

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/orders.{_format} #

Создает новый заказ

Documentation
Sandbox

Documentation

Создает новый заказ

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
order[user_token]		true	Указывается если пользователь не авторизован
order[comment]		true	Комментарий
order[type]	1\|2	true	1 - Новый заказ; 2 - Оплаченный заказ
order[adverts][]		true	Ids объявлений

Return

Parameter	Type	Versions	Description
total	double	*	Сумма
comment	string	*	Комментарий
status	integer	*	Статус
user_token	string	*	Токен
user	object (ObjectId)	*	Пользователь

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/orders/{order}.{_format} #

Заказ по ID. Пользователь видит только свои заказы

Documentation
Sandbox

Documentation

Заказ по ID. Пользователь видит только свои заказы

Requirements

Name	Requirement	Type	Description
_format	json\|html
order

Filters

Name

Information

user_token

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payment_card_files

GET /api/payment_card_files.{_format} #

Возвращает список не активированных файлов с картами оплат

Documentation
Sandbox

Documentation

Возвращает список не обработтаных файлов с картами оплат.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment_card_files.{_format} #

Загрузка файла карт оплат

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
file	string	true

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment_card_files/{payment_card_file}.{_format} #

Возвращает информацию о файле импорта карт оплат по его id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
payment_card_file

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/payment_card_files/{payment_card_file}.{_format} #

Удаление файла с картами оплат

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
payment_card_file		PaymentCardFile

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payment_cards

GET /api/payment_cards.{_format} #

Возвращает список карт оплат

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment_cards/activate.{_format} #

Возвращает список активированных карт оплат карт оплат

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment_cards/{payment_card}.{_format} #

Возвращает информацию о карте по ее id

Documentation
Sandbox

Documentation

Возвращает информацию о карте по ее id

Requirements

Name	Requirement	Type	Description
_format	json\|html
payment_card

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/payment_cards/{payment_card}.{_format} #

Удаляет карту по id.

Documentation
Sandbox

Documentation

Удаляет карту по id. Возможно удалить только не привязанную карту.

Requirements

Name	Requirement	Type	Description
_format	json\|html
payment_card		PaymentCard

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payment_history

GET /api/payment_history.{_format} #

История нововведений

Documentation
Sandbox

Documentation

История нововведений

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payment_log

GET /api/payment_log.{_format} #

Лог операций по оплатам

Documentation
Sandbox

Documentation

Лог операций по оплатам

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payment_statistics

GET /api/payment_statistics.{_format} #

Статистические данные по оплатам

Documentation
Sandbox

Documentation

Статистические данные по оплатам

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/payments

GET /api/payments.{_format} #

Return Payments

Documentation
Sandbox

Documentation

Возвращает список всех платежей для пользователя.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

status

Requirement	\d+
Description	Payment status

user_token

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payments.{_format} #

Создает новую оплату

Documentation
Sandbox

Documentation

Создает новую оплату

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

back_url

Requirement
Description

get_query

Requirement
Description

Parameters

Parameter	Type	Required?	Description
payment[user_token]	string	true	Указывается если пользователь не авторизован
payment[comment]	string	true	Комментарий
payment[order]	string	true	Id заказа
payment[method]	string	true	1 - Pay on-line; 2 - SMS (Lemon Pay); 3 - QIWI (Assist); 4 - Карта Быстрый Курьер; 5 - CMS; 6 - Личный счет, 50 - Pay on-line Visa, 51 - Pay on-line Webmoney, 52 - Pay on-line Yandex Money, 7 - Paypal, 71 - Paypal mobile, 8 - Apple InApp, 9 - PayMaster, 60 - YandexKassa
payment[total]	float	true	Сумма платежа
payment[ip]	string	true	IP адресс пользователя

Return

Parameter	Type	Versions	Description
author_name	string	*	Если платеж совершал незарегистрированный пользователь.
balance	double	*	Баланс

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payments/{payment}.{_format} #

Оплата по ID. Пользователь видит только свои заказы

Documentation
Sandbox

Documentation

Оплата по ID. Пользователь видит только свои заказы

Requirements

Name	Requirement	Type	Description
_format	json\|html
payment

Filters

Name

Information

user_token

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/selfuser

GET /api/selfuser.{_format} #

Возвращает текущего аутентифицированного пользователя в системе

Documentation
Sandbox

Documentation

Возвращает текущего аутентифицированного пользователя в системе;

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/selfuser/device_id.{_format} #

Изменяет идентификатор устройства для пользователя.

Documentation
Sandbox

Documentation

Изменяет идентификатор устройства для пользователя. Данный device_id будет удален у других пользователей.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
device_type	android\|ios	true	платформа
device_id	\w+	true	идентификатор

Status Codes

Status Code	Description
200	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/selfuser/device_id/remove.{_format} #

Убирает из подписки id устройства

Documentation
Sandbox

Documentation

Убирает из подписки id устройства

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
device_type	android\|ios	true	платформа
device_id	\w+	true	идентификатор

Status Codes

Status Code	Description
200	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/selfuser/email_notice.{_format} #

Отменяет или разрешает отправку уведомлений по email.<br>

Documentation
Sandbox

Documentation

Отменяет или разрешает отправку уведомлений по email.
1 - запрещает
0 - разрешает

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
email_notice_disabled	0\|1	true

Status Codes

Status Code	Description
200	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/selfuser/verify_email.{_format} #

Отправить письмо на подтверждение емейл

Documentation
Sandbox

Documentation

Отправить письмо на подтверждение емейл

Возможные ошибки

invalid_email
verify_not_required
self_merge

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
email		true	email

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/selfuser/verify_email_token.{_format} #

Подтверждение смены email

Documentation
Sandbox

Documentation

Подтверждение смены email

Возможные ошибки

invalid_token

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
token		true	Токен
dst_token		true	dst токен

Status Codes

Status Code	Description
204	success
400	fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/statistics

GET /api/statistics.{_format} #

Статистические данные по сайту

Documentation
Sandbox

Documentation

Статистические данные по сайту

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/statistics/last.{_format} #

Последняя статистика

Documentation
Sandbox

Documentation

Последняя статистика

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/statistics/{statistic}.{_format} #

Просмотр статистики

Documentation
Sandbox

Documentation

Просмотр статистики

Requirements

Name	Requirement	Type	Description
statistic	\d+
_format	json\|html

Status Codes

Status Code	Description
200	success

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/subscriptions

GET /api/subscriptions.{_format} #

Возвращает список подписок пользователя

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/subscriptions.{_format} #

Создает подписку для пользователя

Documentation
Sandbox

Documentation

Создает подписку для пользователя

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
filter	\d+	true	id тега
tag	\d+	true	id фильтра
rubric	\d+	true	id рубрики
ext	\d+	true	расширенное
photo	\d+	true	с фото
query[q]	string	true	Строка запроса
query[itemId]	string	true	Искать по номеру
query[in_rubric]	string	true	Искать в рубрике
query[oldq]	string	true	Предыдущий запрос
query[in_found]	string	true	Искать в найденом

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/subscriptions/check.{_format} #

Проверяет есть ли у пользователя подписка с данными параметрами

Documentation
Sandbox

Documentation

Проверяет подписан ли пользователь на запрос

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
filter	\d+	true	id тега
tag	\d+	true	id фильтра
rubric	\d+	true	id рубрики
ext	\d+	true	расширенное
photo	\d+	true	с фото
query[q]	string	true	Строка запроса
query[itemId]	string	true	Искать по номеру
query[in_rubric]	string	true	Искать в рубрике
query[oldq]	string	true	Предыдущий запрос
query[in_found]	string	true	Искать в найденом

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/subscriptions/search.{_format} #

Ищет подписку по уникальному коду

Documentation
Sandbox

Documentation

Ищет подписку по уникальному коду

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

unsubscribe

Requirement
Description	Уникальный код подписки

Status Codes

Status Code	Description
200	Возвращает если подписка найдена

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/subscriptions/unsubscribe.{_format} #

Удаляет подписку по уникальному коду

Documentation
Sandbox

Documentation

Удаляет подписку по уникальному коду

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

unsubscribe

Requirement
Description	Уникальный код подписки

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/subscriptions/{subscription}.{_format} #

Удаляет элемент из подписки

Documentation
Sandbox

Documentation

Удаляет элемент из подписки

Requirements

Name	Requirement	Type	Description
_format	json\|html
subscription

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/tagblocks

GET /api/tagblocks.{_format} #

Return TagBlocks

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/tagblocks.{_format} #

Create new tag_block

Documentation
Sandbox

Documentation

Создает новый выпуск

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
tag_block[title]		true
tag_block[name]		true

Return

Parameter	Type	Versions	Description
title	string	*	Название для сайта

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tagblocks/filter/by/name.{_format} #

Возвращает блок по имя кусок

Documentation
Sandbox

Documentation

Возвращает блок по имя кусок

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

q

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tagblocks/{tag_block}.{_format} #

Return TagBlock by Id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag_block

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/tagblocks/{tag_block}.{_format} #

Редактирование существующего выпуска

Documentation
Sandbox

Documentation

Редактирование существующего выпуска

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag_block

Parameters

Parameter	Type	Required?	Description
tag_block[title]		true
tag_block[name]		true

Return

Parameter	Type	Versions	Description
title	string	*	Название для сайта

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/tagblocks/{tag_block}.{_format} #

Удаляет существующее издание

Documentation
Sandbox

Documentation

Удаляет существующее издание

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag_block

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/tags

GET /api/tags.{_format} #

Return Tags

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

block

Requirement	\d+
Description

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	E.\w+
Description	sort field query parameter

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/tags.{_format} #

Create new tag

Documentation
Sandbox

Documentation

Создает новый выпуск

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
tag[title]		true
tag[name]		true

Return

Parameter	Type	Versions	Description
meta_robots	array	*
meta_title	string	*
meta_keywords	string	*
meta_description	string	*
name	string	*	Имя узла
short_name	string	*	Краткое название

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tags/{tag}.{_format} #

Return Tag by Id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/tags/{tag}.{_format} #

Редактирование существующего выпуска

Documentation
Sandbox

Documentation

Редактирование существующего выпуска

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag

Return

Parameter	Type	Versions	Description
meta_robots	array	*
meta_title	string	*
meta_keywords	string	*
meta_description	string	*
name	string	*	Имя узла
short_name	string	*	Краткое название

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/tags/{tag}.{_format} #

Удаляет существующее издание

Documentation
Sandbox

Documentation

Удаляет существующее издание

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tags/{tag}/first/rubric.{_format} #

Возвращает первую рубрику к которой привязан тег

Documentation
Sandbox

Documentation

Возвращает первую рубрику к которой привязан тег

Requirements

Name	Requirement	Type	Description
_format	json\|html
tag

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/tree

GET /api/tree.{_format} #

Возвращает список TreeNode для родителя.

Documentation
Sandbox

Documentation

Возвращает список TreeNode для родителя. /api/tree.json?depth=1&parent_id=2685&ignore_visibility=1

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

parent_id

Requirement	\d+
Description	id родительского элемента

depth

Requirement	\d+
Description	глубина вложенности (максимум не ограничен)
Default	1

ignore_visibility

Requirement	\d+
Description	игнорировать скрытые элементы (только для администратора)
Default	0

class_filter_type

Requirement	include\|exclude
Description	включая или исключая классы перечисленные в class_filter_array

class_filter_array

Requirement
Description	фильтр по классам Folder, InfoCollector, Rubric, Text

show_in_menu

Requirement	0\|1
Description	Фильтр по флагу 'Не отображать в меню'

affiliate

Requirement	0\|1
Description	Отображать или нет партнерские рубрики

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /api/tree/create/{classID} #

Create TreeNode.

Documentation
Sandbox

Documentation

Create TreeNode.

Requirements

Name	Requirement	Type	Description
classID

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tree/node/menu.{_format} #

Возвращает элементы горизонтального меню

Documentation
Sandbox

Documentation

Возвращает элементы горизонтального меню

Requirements

Name	Requirement	Type	Description
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/tree/node/{id}/move/{sibling}.{_format} #

Перемещает узел по дереву.

Documentation
Sandbox

Documentation

Перемещает узел по дереву.

Requirements

Name	Requirement	Type	Description
id
sibling
_format

Parameters

Parameter	Type	Required?	Description
hit_mode		true

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tree/node/{id}/parents.{_format} #

Возвращает список родителей для узла.

Documentation
Sandbox

Documentation

Возвращает список родителей для узла.

Requirements

Name	Requirement	Type	Description
id
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /api/tree/update/{id} #

Update TreeNode.

Documentation
Sandbox

Documentation

Update TreeNode.

Requirements

Name	Requirement	Type	Description
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /api/tree/{id}/delete.{_format} #

Удаляет TreeNode.

Documentation
Sandbox

Documentation

Удаляет TreeNode.

Requirements

Name	Requirement	Type	Description
id	\d+
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/tree/{id}/show.{_format} #

Возвращает TreeNode.

Documentation
Sandbox

Documentation

Возвращает TreeNode.

Requirements

Name	Requirement	Type	Description
id	\d+
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/api/users

GET /api/users.{_format} #

Возвращает список всех пользователей

Documentation
Sandbox

Documentation

Возвращает список всех пользователей

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

page

Requirement	\d+
Description	page query parameter
Default	1

sort

Requirement	user.\w+
Description	sort field query parameter
Default	1

direction

Requirement	(asc\|desc)
Description	sort direction query parameter
Default	asc

limit

Requirement	\d+
Description	Items count per page
Default	20

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/users.{_format} #

Create new user

Documentation
Sandbox

Documentation

Создание нового пользователя

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?	Description
user[username]		true
user[password]		true
user[email]		true
user[name]		true
user[phone]		true

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/users/filter/by/name.{_format} #

Возвращает пользователя по name piece

Documentation
Sandbox

Documentation

Возвращает пользователя по name piece

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

q

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/users/{id}.{_format} #

Return user by Id

Documentation
Sandbox

Documentation

Возвращает пользователя по id;

Requirements

Name	Requirement	Type	Description
_format	json\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/users/{user}.{_format} #

Обновление существующего пользователя

Documentation
Sandbox

Documentation

Обновление существующего пользователя

Requirements

Name	Requirement	Type	Description
_format	json\|html
user

Parameters

Parameter	Type	Required?	Description
user[new_password]		true
user[email]		true
user[name]		true
user[phone]		true

Status Codes

Status Code	Description
201	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

DELETE /api/users/{user}.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|html
user

Status Codes

Status Code	Description
204	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

/authorize

POST /authorize #

Авторизация пользователя

Documentation
Sandbox

Documentation

Авторизация пользователя

Filters

Name

Information

_username

Requirement
Description

_password

Requirement
Description

_remember_me

Requirement	0\|1
Description

Status Codes

Status Code	Description
200	Returned when successful
403	Returned when the user is not authorized

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /authorize/oauth #

Авторизация пользователя с помошью токена социальных сетей

Documentation
Sandbox

Documentation

Авторизация пользователя с помошью токена социальных сетей. Если пользователь уже авторизован, социальный аккаунт будет присоединен к уже имеющемуся.

Пример успешного ответа сервера в случае авторизации пользователя

{ApiKey:xxx, expiresAt:yyy}

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

{result:success}

Возможные ошибки

unsupported_provider
already_linked

Parameters

Parameter	Type	Required?	Description
token		true
provider	vk\|gplus\|facebook	true

Status Codes

Status Code	Description
200	В случае успеха
400	В случае ошибки

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /api/content/{path}.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
path	.+
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /api/content/{path}/show/{id}.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
path	.+
id	\d+
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/files/create.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/files/{id}/delete.{_format} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/issue/archive/pay.{_format} #

Оплачивает архив пользвателю, создает платеж и списывает с баланса денежку

Documentation
Sandbox

Documentation

Оплачивает архив пользвателю, создает платеж и списывает с баланса денежку

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issue/period.{_format} #

Возвращает список выпусков по параметрам, месяц и год с прикрепленным файлом( архивом )

Documentation
Sandbox

Documentation

Возвращает список выпусков по параметрам, месяц и год с прикрепленным файлом( архивом )

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

id

Requirement	\d+
Description	Issue id

year

Requirement	\d+
Description	Issues in year

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/issue/years.{_format} #

Возвращает список лет в которых есть выпуски

Documentation
Sandbox

Documentation

Возвращает список лет в которых есть выпуски

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/itunes.{_format} #

Валидирует ответ от iTunes In-App Purchases

Documentation
Sandbox

Documentation

Валидирует ответ от iTunes In-App Purchases Если платеж успешный - пополняет личный счет пользователя.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
receipt	string	true
sandbox	boolean	true
user_id	int	true
ip	string	true
total	float	true

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment/paymaster/status.{_format} #

Статус платежа в PayMaster по идентификатору платежа

Documentation
Sandbox

Documentation

Статус платежа в PayMaster по идентификатору платежа

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

payment_id

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment/paymaster/status/invoice.{_format} #

Статус платежа в PayMaster по номеру счета

Documentation
Sandbox

Documentation

Статус платежа в PayMaster по номеру счета

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

payment_id

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment/paypal.{_format} #

Проверяет статус платежа PayPal

Documentation
Sandbox

Documentation

Проверяет статус платежа PayPal

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

paypal_payment_id

Requirement
Description

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/paypal.{_format} #

Валидирует ответ от IPN Paypal

Documentation
Sandbox

Documentation

Валидирует ответ от IPN Paypal Если платеж успешный - пополняет личный счет пользователя.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
item_number	string	true
mc_gross	string	true
protection_eligibility	string	true
address_status	string	true
payer_id	string	true
tax	string	true
address_street	string	true
payment_date	string	true
payment_status	string	true
charset	string	true
address_zip	string	true
first_name	string	true
mc_fee	string	true
address_country_code	string	true
address_name	string	true
notify_version	string	true
custom	string	true
payer_status	string	true
business	string	true
address_country	string	true
address_city	string	true
quantity	string	true
verify_sign	string	true
payer_email	string	true
txn_id	string	true
payment_type	string	true
last_name	string	true
address_state	string	true
receiver_email	string	true
payment_fee	string	true
receiver_id	string	true
txn_type	string	true
item_name	string	true
mc_currency	string	true
residence_country	string	true
handling_amount	string	true
transaction_subject	string	true
payment_gross	string	true
shipping	string	true
ipn_track_id	string	true

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/response/lemonpay.{_format} #

/api/payment/response/lemonpay

Documentation
Sandbox

Documentation

/api/payment/response/lemonpay Ответ LemonPay о проведении платежа

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

trn_id

Requirement
Description

pos_trn_id

Requirement
Description

pos_trn_time

Requirement
Description

amount

Requirement
Description

currency

Requirement
Description

trn_time

Requirement
Description

payment_method_id

Requirement
Description

action

Requirement
Description

sign

Requirement
Description

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/response/paymaster/confirmation.{_format} #

PayMaster Invoice Confirmation

Documentation
Sandbox

Documentation

Invoice Confirmation

Этот HTTP POST запрос отправляется системой PayMaster на веб-сервер продавца, на URL, указанный в настройках, в тот момент, когда пользователь выбрал платежную систему и собирается производить платеж. В зависимости от настроек, продавец может игнорировать запрос, или обязан на него ответить.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
LMI_PREREQUEST	string	true
LMI_MERCHANT_ID	string	true
LMI_PAYMENT_NO	int	true
LMI_PAYMENT_AMOUNT	string	true
LMI_CURRENCY	string	true
LMI_PAID_AMOUNT	string	true
LMI_PAID_CURRENCY	string	true
LMI_PAYMENT_SYSTEM	string	true
LMI_PAYMENT_METHOD	string	true
LMI_SIM_MODE	string	true
LMI_PAYMENT_DESC	string	true
LMI_SHOP_ID	string	true

Status Codes

Status Code	Description
200	Returned when successful
422	Returned when fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/response/paymaster/notification.{_format} #

PayMaster Invoice Confirmation

Documentation
Sandbox

Documentation

Payment Notification

Этот HTTP POST запрос отправляется продавцу системой PayMaster в том случае, когда платеж успешно проведен.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Parameters

Parameter	Type	Required?
LMI_MERCHANT_ID	string	true
LMI_PAYMENT_NO	int	true
LMI_SYS_PAYMENT_ID	string	true
LMI_SYS_PAYMENT_DATE	string	true
LMI_PAYMENT_AMOUNT	float	true
LMI_CURRENCY	string	true
LMI_PAID_AMOUNT	float	true
LMI_PAID_CURRENCY	string	true
LMI_PAYMENT_SYSTEM	string	true
LMI_PAYMENT_METHOD	string	true
LMI_SIM_MODE	string	true
LMI_PAYMENT_DESC	string	true
LMI_HASH	string	true
LMI_PAYER_IDENTIFIER	string	true
LMI_SHOP_ID	string	true
LMI_PAYER_COUNTRY	string	true
LMI_PAYER_PASSPORT_COUNTRY	string	true
LMI_PAYER_IP_ADDRESS	string	true

Status Codes

Status Code	Description
200	Returned when successful
422	Returned when fail

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/payment/response/payonline.{_format} #

Ответ с сервиса PayOnLine о статусе платежа

Documentation
Sandbox

Documentation

Ответ с сервиса PayOnLine о статусе платежа

Requirements

Name	Requirement	Type	Description
_format	json\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/payment/response/paypal.{_format} #

Завершает платеж по данным от PayPal

Documentation
Sandbox

Documentation

Завершает (проводит) платеж PayPal который ранее был одобрен покупателем.

https://developer.paypal.com/webapps/developer/docs/api/#execute-an-approved-paypal-payment

Возвращает статус платежа - created; approved; failed; canceled; expired; pending;

В случае если не удалось получить ответ от PayPal - сообщение об ошибке.

Requirements

Name	Requirement	Type	Description
_format	json\|html

Filters

Name

Information

payment_id

Requirement
Description

payer_id

Requirement
Description

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/rubrics/{rubric}/adverts.{_format} #

Объявления для рубрики.

Documentation
Sandbox

Documentation

Объявления для рубрики. Пользователь видит только опубликованные объявления Администратор видит все объявления

Requirements

Name	Requirement	Type	Description
_format	json\|html
rubric

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/rubrics/{rubric}/adverts/nested.{_format} #

Объявления для рубрики, включая вложенные рубрики

Documentation
Sandbox

Documentation

Объявления для рубрики, включая вложенные рубрики Пользователь видит только опубликованные объявления Администратор видит все объявления

Requirements

Name	Requirement	Type	Description
_format	json\|html
rubric

Filters

Name

Information

depth

Requirement	\d+
Description
Default	1

limit

Requirement	\d+
Description
Default

offset

Requirement	\d+
Description
Default	1

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/settings/run_reindex #
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand]

Response Body [Raw]
GET /api/settings/show #
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/settings/update/{type} #

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
type

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

ANY /register/ #

Регистрация нового пользователя

Documentation
Sandbox

Documentation

Регистрация нового пользователя

Parameters

Parameter	Type	Required?
bk_user_register[username]	string	true
bk_user_register[email]	string	true
bk_user_register[plainPassword][first]	string	true
bk_user_register[plainPassword][second]	string	true
bk_user_register[name]	string	true
bk_user_register[phone]	string	true

Status Codes

Status Code	Description
400	Returned when bad request

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /register/confirm/{token} #

Receive the confirmation token from user email provider, login the user

Documentation
Sandbox

Documentation

Receive the confirmation token from user email provider, login the user

Requirements

Name	Requirement	Type	Description
token

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /register/mobile #

Регистрация

Documentation
Sandbox

Documentation

Регистрация для пользователей с мобильных устройств(не требуется подтверждение email).

В случае успешной регистрации возвращается

{result:success}

Возможные ошибки

fos_user.username.blank
fos_user.username.short
fos_user.username.long
fos_user.email.blank
fos_user.email.short
fos_user.email.long
fos_user.email.invalid
fos_user.password.blank
fos_user.password.short
fos_user.password.mismatch

Parameters

Parameter	Type	Required?
bk_user_register[username]	string	true
bk_user_register[email]	string	true
bk_user_register[plainPassword][first]	string	true
bk_user_register[plainPassword][second]	string	true
bk_user_register[name]	string	true
bk_user_register[phone]	string	true

Status Codes

Status Code	Description
200	В случае успеха
400	В случае ошибки

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

form.is_bound	Флаг отправки данных. DEV
form.is_valid	Флаг валидности данных. DEV
form.name	Имя формы. Обычно данные вкладываются в массив с именем формы при отправке
form.data_class	DEV
form.extra	Массив данных, для которых не предусмотрена обработка.
form.errors	Данные не прошедшие валидацию
form.errors.FIELD_NAME	Массив ошибок

API documentation

Основые принципы работы

/api/adverts

POST /api/adverts.{_format} #

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/affiliate/rubrics.{_format} #

Documentation

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

POST /api/adverts/email/favorite.{_format} #

Documentation

Requirements

Filters

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/favorites.{_format} #

Documentation

Requirements

Requirements

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/my.{_format} #

Documentation

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/search.{_format} #

Documentation

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/search/rubrics.{_format} #

Documentation

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

GET /api/adverts/{advert}.{_format} #

Documentation

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand]

Response Body [Raw]

PUT /api/adverts/{advert}.{_format} #

Documentation

Requirements

Parameters

Status Codes