Документация по работе с API Скриншот сайта
Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/screensite.php с персональным ключом API и параметрами.
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
История изменений/обновлений
| type (тип) | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| fullscreen | Сделать полноразмерный скриншот сайта Скриншот от верха до низа сайта |
Обязательные url - Ссылка на сайт (формата https://site.ru) screen - Разрешение экрана Доступные разрешения: 1920x1080 1366x768 1536x864 1440x900 720x1280 750x1334 token - персональный ключ API |
| screen | Сделать скриншот сайта Обычный скриншот, верхней видимой части в браузере. |
Обязательные url - Ссылка на сайт (формата https://site.ru) screen - Разрешение экрана Доступные разрешения: 1920x1080 1366x768 1536x864 1440x900 720x1280 750x1334 token - персональный ключ API |
Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}
Примеры запросов
Пример запроса успешного запроса HTTP GET на URL нашего API
https://api-cloud.ru/api/screensite.php?type=fullscreen&url=https://google.com&screen=1920x1080&&token=53ba1b7a55abbB014aa97eff3a522079
{
"status":200, // Статус ответа
"imgurl":"https://api-cloud.ru/api/notification/7be745c88785bb814b1bcba603a2e519.png", // Временная ссылка на скриншот (15 минут)
"inquiry":{
"price":0.4,
"balance":758.74,
"speed":7,
"attempts":1
}
История изменений API Скриншот сайта
| дата | что изменилось |
|---|---|
| 26.03.2023 | Добавлен метод запроса screen. Позволяет сделать скриншот сайта верхней видимой части в браузере. |
Возможные коды ошибок
| код (error) | Описание ошибки (message) |
|---|---|
| 888 | ИМЯ передаваемой переменной: forbidden symbols present В переменной ИМЯ присутствуют запрещенные символы |
| 766 | MISSING_MANDATORY_PARAMETER Отсутствуют обязательные параметры |
| 602 | TOKEN_NO_ACCESS Нет доступа к запрашиваему методу запроса |
| 504 | TOKEN_LOCKED_IN_THE_SYSTEM Переданный токен заблокирован службой качества / автоматической системой |
| 503 | TOKEN_NOT_REGISTERED_IN_THE_SYSTEM Переданный токен не зарегистрирован в системе |
| 502 | MISSING_REQUIRED_TOKEN_PARAMETER Отсутствует параметр token |
| 500 | MISSING_REQUIRED_TYPE_PARAMETER Отсутствует параметр type |
| 499 | WRONG_TOKEN_KEY Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа. |
| 498 | TOKEN_NO_MONEY Для выполнения запроса недостаточно средств, пополните баланс. |
| 460 | NO_REQUIRED_PARAMETERS Отсутствуют обязательные параметры |
| 456 | MAX_LIMIT Превышено количество одновременных соединений (потоки) |
| 404 | TIME_MAX_CONNECT Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже. |
| 123 | IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК |
| 111 | PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно. |
| 015 | DATE_ERROR Ошибка значения переданной даты |
| 005 | TEST_TIME_OFF Закончился период тестирования |
| 003 | TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой |
| 002 | TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности. |
| 001 | API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже. |
{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}