Описание
Sape.ru Xml-RpcНаш xml-rpc интерфейс доступен по адресу http://api.sape.ru/xmlrpc/. Обращаться нужно по 80-му порту, тело xml-запроса класть в POST_DATA. Всё общение происходит полностью в кодировке UTF-8. Кроме того, можно работать по https по адресу https://api.sape.ru/xmlrpc/.
Если Вы ещё ничего не знаете про XML-RPC, то рекомендуем почитать на сайте www.xmlrpc.com:
- Реализация протокола для Вашего любимого языка программирования.
- Для любителей PHP рекомендуем Zend Framework
Функции
Описание
Авторизация в системе, необходимо вызывать в начале каждой сессии. Далее при каждом следующем запросе нужно передавать все вернувшиеся cookie. Результатом выполнения функции является id пользователя. Для генерации токена для своегоаккаунта перейдите на эту страницу: http://passport.sape.ru/security/token/
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
login | string | Да | - | логин |
token | string | Да | - | токен |
Возвращаемое значение
Тип | Описание |
int | ID пользователя |
Описание
Получение информации о текущем пользователе.
Возвращаемое значение
Тип | Описание |
array |
Содержит следующие значения:
|
Описание
Получение текущего баланса пользователя, включая заблокированные средства.
Возвращаемое значение
Тип | Описание |
float | баланс пользователя |
Описание
Получение доступного баланса пользователя.
Возвращаемое значение
Тип | Описание |
float | баланс пользователя |
Описание
Получение текущего баланса пользователя с детализацией блокировок.
Возвращаемое значение
Тип | Описание |
array |
Содержит следующие значения:
|
Описание
Получение данных по датам зачисления/поступления денег в разрезе каждого счета. По умолчанию выводятся счета аккаунтов привязанных к юрлицу, если такая связь есть, если нужно получить счета по конкретному аккаунту, то необходимо установить параметр userId, если userId == true, то выводится информация по текущему пользователю.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
dateYear | int | Да | - | Год выборки |
dateMonth | int | Нет | null | Месяц выборки |
dateDay | int | Нет | null | День выборки |
userId | int | Нет | null | ID пользователя |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списка неоплаченных счетов пользователя.
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списка доменов пользователя.
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списка ID доменов площадок, на которых есть размещенные ссылки.
Возвращаемое значение
Тип | Описание |
array | список ID доменов |
Описание
Проверка домена на наличие ссылок в статусе ОК.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
domain | string | Да | - | домен |
Возвращаемое значение
Тип | Описание |
boolean | Возможные значения:
|
Описание
Получение параметров проекта пользователя.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
Возвращаемое значение
Тип | Описание |
array |
Содержит следующие значения:
|
Описание
Получения списока проектов пользователя.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
options | array | Нет | null |
Содержит следующие значения:
|
pn | int | Нет | 0 | Номер страницы (для пагинации). |
ps | int | Нет | 10000 | Количество элементов для вывода на странице (для пагинации). |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Создание нового проекта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
name | string | Да | - | имя проекта |
options | array | Нет | array() |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
int | ID созданного проекта |
Описание
Изменение настроек проекта в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
options | array | Да | - |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списка ID площадок, на размещены ссылки.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
Возвращаемое значение
Тип | Описание |
array | cписок ID площадок |
Описание
Получение списка ссылок для проекта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectIds | int|array | Да | - | идентификатор проекта |
options | array | Нет | array() | параметры фильтрации:
|
dateStart | timestamp | Нет | null | дата начала |
dateStop | timestamp | Нет | null | дата окончания |
pn | int | Нет | 0 | номер страницы (для пагинации) |
Возвращаемое значение
Тип | Описание |
array | массив ссылок проекта:
|
Описание
Получение статистики по проектам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectIds | int|array | Да | - | ID проектов |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списка разделов проектов.
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Перенос проекта в другой раздел.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
folderId | int | Да | - | ID директории |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Удаление проекта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение информация о УРЛе (включая удалённые).
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID урла |
showDeleted | boolean | Нет | false | показываеть удаленные |
Возвращаемое значение
Тип | Описание |
array |
Содержит следующие значения:
|
Описание
Получение списка УРЛов проекта (включая удалённые).
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
showDeleted | boolean | Нет | false | показываеть удаленные |
options | array | Нет | array() |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Добавление в проект нового УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
url | string | Да | - | УРЛ |
name | string | Нет | - | Имя УРЛа |
keyword | int|string | Нет | - | Ключевое слово |
Возвращаемое значение
Тип | Описание |
int | ID созданного УРЛа |
Описание
Изменение настроек УРЛа в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
params | array | Да | - |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списка ссылок для УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int|array | Да | - | ID УРЛа |
options | array | Нет | array() | Параметры фильтрации:
|
dateStart | timestamp | Нет | null | Дата начала |
dateStop | timestamp | Нет | null | Дата окончания |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение количества ссылок по урлам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectIds | int|array | Да | - | ID проектов |
status | string | Нет | null | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом.:
|
dateStart | timestamp | Нет | null | Дата начала |
dateStop | timestamp | Нет | null | Дата окончания |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списока анкоров УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение количества анкоров УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
Возвращаемое значение
Тип | Описание |
int | количества анкоров УРЛа |
Описание
Получение количества анкоров по списку УРЛов.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
params | array | Нет | null |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Изменение режима модерации УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
flagAuto | boolean | Да | - | покупать сссылки автоматически |
flagRequireConfirm | boolean | Да | - | необходимо подтверждение размещения ссылки |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Удаление УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списока сайтов пользователя.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
options | array | Нет | null |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Добавление площадки в систему.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
url | string | Да | - | УРЛ |
categoryId | int | Да | - | ID категории |
urlCode | string | Нет | null | УРЛ страницы, на которой размещен клиентский код |
Возвращаемое значение
Тип | Описание |
int | ID сайта |
Описание
Изменение настроек сайта в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
params | array | Да | - |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Количество страниц по одному сайту.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
status | string | Нет | null | статус страницы:
|
Возвращаемое значение
Тип | Описание |
int | количество страниц по одному сайту |
Описание
Количество контекстных страниц по одному сайту.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
status | string | Нет | null | статус страницы:
|
Возвращаемое значение
Тип | Описание |
int | количество контекстных страниц по одному сайту |
Описание
Получение списка разделов для сайтов.
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Перенос cайта в другой раздел.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
folderId | int | Да | - | ID директории |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списка регионов сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
Возвращаемое значение
Тип | Описание |
array | Список регионов сайта |
Описание
Установка максимального количества ссылок. Увеличивать максимальное количество ссылок можно не чаще чем 1 раз в 2 недели.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
params | array | Нет | null |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение ссылок для сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
options | array | Нет | array() |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение количества ссылок по сайтам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
status | string | Нет | null | статус ссылки:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Отправка сайта на переиндексацию страниц.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Удаление площадки из системы.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение свойств страницы сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
pageId | int | Да | - | ID страницы |
Возвращаемое значение
Тип | Описание |
array |
Содержит следующие значения:
|
Описание
Получение списка страниц сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
filter | array | Нет | null |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Активация страниц сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Нет | null | ID сайта |
pageIds | int|array | Нет | null | ID страниц |
flagContext | boolean | Нет | false | если указано true, то будет активирована контекстная страница, в противном случае - обычная |
Возвращаемое значение
Тип | Описание |
int | количество активированных страниц |
Описание
Исключение страниц сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Нет | null | ID сайта |
pageIds | int|array | Нет | null | ID страниц |
flagContext | boolean | Нет | false | если указано true, то будет исключена контекстная страница, в противном случае - обычная |
Возвращаемое значение
Тип | Описание |
int | количество исключенных страниц |
Описание
Удаление страниц сайта.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Нет | null | ID сайта |
pageIds | int|array | Нет | null | ID страниц |
flagContext | boolean | Нет | false | если указано true, то будет удалена контекстная страница, в противном случае - обычная |
Возвращаемое значение
Тип | Описание |
int | количество удаленных страниц |
Описание
Получение количества страниц по сайтам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
status | string | Нет | null | статус страницы:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение количества контекстных страниц по сайтам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
status | string | Нет | null | статус страницы:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Изменение цены страницы.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
pageId | int | Да | - | ID страницы |
priceNew | float | Да | - | цена |
changePlaced | boolean | Нет | false | обновятся цены на проданные ссылки |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Изменение цены страниц.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
level | int | Да | - | уровень вложенности (от 1 до 3) |
pr | int | Да | - | PageRank (от 0 до 9), может принимать значение 'all', если необходимо установить одну цену для определенного уровня вложенности |
priceNew | float | Да | - | цена |
changePlaced | boolean | Нет | false | обновятся цены на проданные ссылки |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списка ссылок на странице.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
pageId | int|array | Да | - | Идентификатор страницы |
options | array | Нет | array() | Параметры фильтрации:
|
dateStart | timestamp | Нет | null | Дата начала |
dateStop | timestamp | Нет | null | Дата окончания |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Список ссылок:
|
Описание
Получение статистики расходов по проекту.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
projectId | int | Да | - | ID проекта |
year | int | Нет | null | год выборки |
month | int | Нет | null | месяц выборки |
day | int | Нет | null | день выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики расходов по всем проектам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
year | int | Нет | null | год выборки |
month | int | Нет | null | месяц выборки |
day | int | Нет | null | день выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики расходов по УРЛу.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
year | int | Нет | null | год выборки |
month | int | Нет | null | месяц выборки |
day | int | Нет | null | день выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики расходов для списка УРЛов.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlIds | array | Да | - | список ID УРЛов |
year | int | Да | - | год выборки |
month | int | Нет | null | месяц выборки |
day | int | Нет | null | день выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики расходов по сайту.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
siteId | int | Да | - | ID сайта |
year | int | Нет | null | год выборки |
month | int | Нет | null | месяц выборки |
day | int | Нет | null | день выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики изменений баланса.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
year | int | Нет | null | Год выборки |
month | int | Нет | null | Месяц выборки |
day | int | Нет | null | День выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение статистики по партнерской программе.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
year | int | Нет | null | Год выборки |
month | int | Нет | null | Месяц выборки |
day | int | Нет | null | День выборки |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Получение списка фильтров.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
options | array | Нет | null |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Добавление фильтра с указанными параметрами.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterName | string | Да | - | имя фильтра |
filter | array | Да | - |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
int | ID нового фильтра |
Описание
Изменение параметров фильтра.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterId | int | Да | - | ID фильтра |
filter | array | Да | - |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Получение списка автофильтров для списка УРЛов.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlIds | array | Да | - | список УРЛов |
showParams | boolean | Нет | false | если равно true, то добавляются следующие поля: current_quant, current_price |
Возвращаемое значение
Тип | Описание |
array |
Список, каждый элемент которого содержит:
|
Описание
Создание авто-фильтра для урла.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterId | int | Да | - | ID фильтра |
urlId | int | Да | - | ID УРЛа |
quant | int | Да | - | количество |
price | float | Да | - | цена |
dailyQuota | int | Да | - | дневная квота |
Возвращаемое значение
Тип | Описание |
int | ID авто-фильтра |
Описание
Изменение авто-фильтра для УРЛа.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterAutoId | int | Да | - | ID авто-фильтра |
quant | int | Да | - | количество |
price | float | Да | - | цена |
dailyQuota | int | Да | - | дневная квота |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Удаление авто-фильтра.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterAutoId | int | Да | - | ID авто-фильтра |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Удаление фильтра.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
filterId | int | Да | - | ID фильтра |
forceDelete | boolean | Нет | false | если параметр true, то удаляет все автофильтры которые привязаны к фильтру, в противном случае выполняет проверку есть ли автофильтры и если есть, то не будет удалять фильтр |
Возвращаемое значение
Тип | Описание |
boolean | результат операции |
Описание
Поиск сайтов и страниц для УРЛа urlId по параметрам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
filter | array | Да | - | фильтр:
|
pn | int | Нет | 0 | номер страницы (для пагинации) |
ps | int | Нет | 100 | кол-во сообщений на странице |
Возвращаемое значение
Тип | Описание |
array | Результат поиска:
|
Описание
Поиск страниц для УРЛа urlId по параметрам.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
urlId | int | Да | - | ID УРЛа |
filter | array | Да | - | фильтр:
|
pn | int | Нет | 0 | номер страницы (для пагинации). |
ps | int | Нет | 100 | кол-во результатов на странице. |
Возвращаемое значение
Тип | Описание |
array | Результат поиска:
|
Описание
Размещение новой ссылки.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
pageId | int | Да | - | ID страницы |
urlId | int | Да | - | ID УРЛа |
anchor | int|string | Да | - | если anchor число, то выбирается текст из БД текстов по ID; если anchor = 0, то берётся следующий неиспользованный текст |
hash | array | Нет | array() |
Содержит следующие значения:
|
Возвращаемое значение
Тип | Описание |
string | ID ссылки |
Описание
Размещение списка новых ссылок.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
placements | array | Нет | array() |
Список, каждый элемент которого содержит:
|
Возвращаемое значение
Тип | Описание |
array | в случае успеха возвращается массив с ID ссылок или описаниями ошибок |
Описание
Получение текущего статуса ссылки по ID.
Аргументы
Имя | Тип | Обязательно | По умолчанию | Описание |
placementId | int | Да | - | ID ссылки |
checkSleepBalance | boolean | Нет | false | флаг указывающий на то, что нужно проверить на биллинговый слип |
Возвращаемое значение
Тип | Описание |
string | статус ссылки или если указан флаг checkSleepBalance, то будет возвращён массив со следующими полями:
|