ZzWeb POST GET

Метод позволяет создавать новые странички в системе ZzWeb.


Запросы следует отправлять на адрес:

Поддерживаются запросы методом GET и POST.

По умолчанию ответ сервера будет в формате JSON. Для получения ответа в другом формате, можно добавить расширение к файлу в адресе: .xml, .html или .txt. Например: /v2/ZzWeb.xml Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
title String Нет NULL Заголовок страницы. Может быть создан автоматически, если указан параметр description.
description String Условно NULL Описание zz-страницы. Если отсутсвует images, текст должен быть достаточно информативным (несколько строк).
email String Нет NULL Email пользователя, от имени которого создается zz-страница.
pwd String Нет NULL Пароль пользователя, от имени которого создается zz-страница.
images File[] Условно NULL Коллекция изображений, которые будут добавлены на zz-страницу. Размер одного файла не должен превышать 3 Мб. Для загрузки допускаются только графические файлы в форматах: PNG, JPG/JPEG и GIF. Необходимо обязательно указывать имена файлов!
type ZzWebType Нет Default Тип создаваемой страницы.
author String Нет NULL Имя автора страницы (используется в подписи).
disableComments Boolean Нет False Указывает, следует запретить комментарии на zz-странице или нет.
disableSocial Boolean Нет False Указывает, следует запретить вывод социальных кнопок на zz-странице или нет.
disableRss Boolean Нет False Указывает, следует запретить вывод zz-страницы в RSS или нет.
lepota Boolean Нет False Указывает, следует использовать специальное оформеление zz-страницы или нет.
test Boolean Нет False Включает тестовый режим. Рекомендуется использовать тестовый режим для тестирования взаимодействия с ZzWeb. Страницы созданные в тестовом режиме будут доступны только на тестовом сайте. Тестовый режим не предназначен для создания обычных страниц, данные с тестового сайта могут быть удалены, а также могут быть ограничения на доступность тестовых страниц для поисковых систем. Авторизация в тестовом режиме не используется.
pid Int64 Нет NULL Идентификатор родительской страницы.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.

Имя параметра Тип Обязательный По умолчанию Описание
appId Int32 Нет NULL Идентификатор приложения.
appSecret String Условно NULL Секретный ключ приложения.
token String Нет NULL Маркер доступа клиента, полученный методом GetToken.
formatting ResponseFormatting Нет None Определяет параметры форматирования выдачи результатов.
details Boolean Нет False Позволяет отобразить дополнительную информацию о запросе.
cp String Нет UTF-8 Имя кодовой страницы.
lang Language Нет Auto Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API.
auth Boolean Нет False При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization.

Результат

Возвращает результат типа StringResult.

Имя свойства Тип Описание
Исходное XML JSON
Value value value String Ссылка на созданную zz-страничку.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.

Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.

Исходное имя - это имя, которое используется непосредственно в коде API.


Ошибки

При возникновении ошибок, будет возвращаен результат типа ErrorResult.

В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом ZzWeb.

Ключ Код Описание
ArgumentNullOrEmpty 2001 Ошибка происходит, если один из обязательных параметров не указан или имеет пустое значение.
ArgumentOutOfRange 2002 Ошибка возникает, когда значение одного из аргументов не попадает в допустимый диапазон.
ExternalServiceError 5001 Возникает, если при запросе к удаленному серверу была получена ошибка.
InvalidFileType 3002 Ошибка происходит, при попытке передать методу файл неправильного формата. Как правило, проверка типа файла осуществляется по данным заголовка Content-Type.

Ключ и код соответствуют элементам перчисления ErrorCode.

В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages. При этом, ответ сервера будет иметь тип StringResult.

Если метод содержит сообщения типа Critical, то можно считать, что работа метода завершена с ошибкой. Подобное поведение свойствено методам, в которых производится обработка списка данных, где каждый элемент списка является независимым от других элментов. Т.е. в таких случаях запрос может быть выполнен частично.


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

Служба предоставляется на условиях «КАК ЕСТЬ».
Стабильность работы службы не гарантируется.

FoxTools.ru не сохраняет данные, передаваемые в метод ZzWeb, в том числе EMAIL и PWD. При отсутствии параметров EMAIL и PWD, FoxTools.ru оставляет за собой право отправлять в ZzWeb.ru собственные учетные данные, т.е. размещать zz-страничку под своей учетной записью.

FoxTools.ru не несет ответственности за перехват передаваемых данных третьими лицами, в том числе по направлению к серверу FoxTools.ru, а также при передаче данных от сервера FoxTools.ru к серверу ZzWeb.ru.

FoxTools.ru всегда передает полученный от клиента IP-адрес серверу ZzWeb.ru.

FoxTools.ru не несет ответственности за неправомерное использование системы ZzWeb.ru, ответственность перед ZzWeb.ru в полном объеме несет пользователь.

FoxTools.ru оставляет за собой право в любое время останавливать, изменять службу, ограничивать доступ к службе, без отдельного уведомления об этом.


Статистика


Конструктор запросов

title:
description:
email:
pwd:
images:

Добавить еще

type:
author:
disableComments:
disableSocial:
disableRss:
lepota:
test:
pid:

http:
lang:
auth:
cp: