Внимание! Запущено тестирование FoxTools API v2.0!
Если у вас возникнут каки-либо вопросы по работе с API, вы можете оставлять их на форуме группы FoxTools.ru.

WebScreen

Метод делает снимок (скриншот) указанной интернет-странички и возвращает ссылку на него.

Параметры

Имя параметра Тип Обязательный Описание
URL Строка Да Адрес странички, снимок с которой нужно сделать.

Примечания

Метод возвращает адрес страницы снимка экрана страницы, указанной в параметре URL.
На создание снимка страницы может потребоваться какое-то время. Позиция очереди для XML и JSON будет возвращена в дополнительном параметре - NUMBER.

При повторном запросе URL, будет возвращена первая ссылка на снимок (новые не создаются). Если снимок был создан более суток назад, то снимок будет поставлен в очередь на обновление. Для XML и JSON детали о состоянии ссылки могут быть указаны в параметре MESSAGE, в ответе сервера.

JavaScript, Flash отключены.
HTML5 поддерживается неполностью.
Запросы по протоколу HTTPS не выполняются.
Если тип содержимого URL отличается от text/html, text/plain - в выполнении запроса будет отаказано. Ожидание ответа от сервера не более 60 секунд.


В случае успешного создания снимка страницы (URL), размер изображения будет соответствовать размеру содержимого страницы.
Вы можете добавлять к адресу страницы параметры: w и h, чтобы запросить изображение в отличном от оригинала размере. Можно указать как оба параметра, так и один. В последнем случае, размер будет изменен пропорционально.
Изображения выдаются в формате PNG.


Общие сведения

Все команды к API необходимо делать методом POST, на этот же адрес, на котором вы находитесь в данный момент (исключая корневой арес сайта). Тип содержимого (Content-Type) при запросах к API должен быть multipart/form-data.

Для доступа к API обязательно нужно передовать идентификатор и открытый ключ доступа, которые можно получить в личном кабинете на сайте http://foxtools.ru в свойствах подключенного к сервису сайта.

Параметры для доступа к API

Имя параметра Тип Обязательный Описание
ID Целое число Да Уникальный идентификатор сайта в системе.
KEY Guid Да Открытый ключ доступа к API.
CID Целое число Нет Пользовательский идентификатор. Данный параметр можно передавать, чтобы получать более детальную статистику использования сервера. Например, в этот параметр можно передавать идентификатор пользователя в вашей БД, чтобы знать, сколько раз пользователь использовал тот или иной сервис.
CGRP Целое число Нет Группа для пользовательских идентификаторов (CID). Вы можете использовать этот параметр для группировки статистических данных. Например, если в CID вы передаете идентификатор пользователя в вашей БД, то параметр CGRP может быть равен 1. Если в CID вы передаете идентификатор страницы на вашем сайте, то CGRP может быть равен 2. Таким образом, вы сможете выделять статистику для пользователей (CGRP = 1) и страниц (CGRP = 2).

Примечание. Регистр символов значения не имеет. Это касается любых параметров, как имен, так и значений.

Формат ответа

Выдача результата в API возможна в трех форматах: XML (по умолчанию), JSON, текстовой.
Для указания формата выдачи необходимо добавить к адресу страницы запроса имя желаемого формата, через слеш.

Например:
http://api.foxtools.ru/v1/WebScreen/xml
http://api.foxtools.ru/v1/WebScreen/json
http://api.foxtools.ru/v1/WebScreen/text




Дополнительная информация

Состояние: Работает
Использование: Бесплатно
Всего запросов: 25242
Запросов сегодня: 0
Первый запрос: 16.01.2013 16:30:43
Последний запрос: 19.06.2016 4:53:44


Комментарий администратора

Тестовая версия.