Веб-сайты

Аутентификация
API-ключ должен быть отправлен как токен Bearer в заголовке Authorization запроса. Получить ваш API-ключ.
Список

API-точка доступа

GET
https://vstat.org/api/v1/websites

Пример запроса

curl --location --request GET 'https://vstat.org/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameters

Имя
Тип
Описание
search
необязательно string
Поисковый запрос.
search_by
необязательно string
Поиск по. Возможные значения: domain для Домен. По умолчанию: domain.
favorite
необязательно boolean
Фильтровать по избранному.
sort_by
необязательно string
Сортировать по. Возможные значения: id для Дата создания, domain для Домен. По умолчанию: id.
sort
необязательно string
Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.
per_page
необязательно integer
Результатов на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

API-точка доступа

GET
https://vstat.org/api/v1/websites/{id}

Пример запроса

curl --location --request GET 'https://vstat.org/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Магазин

API-точка доступа

POST
https://vstat.org/api/v1/websites

Пример запроса

curl --location --request POST 'https://vstat.org/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'

Parameters

Имя
Тип
Описание
domain
обязательно string
Имя домена
privacy
необязательно integer
Конфиденциальность. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.По умолчанию: 1.
password
необязательно string
Пароль. Работает только с полем privacy, установленным в 2.
email
необязательно integer
Периодические отчеты по электронной почте. Возможные значения: 0 для Отключен, 1 для Включено. По умолчанию: 0.
exclude_bots
необязательно integer
Исключить обычных ботов из отслеживания. Возможные значения: 0 для Отключен, 1 для Включено. По умолчанию: 1.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. Один на строку.
exclude_ips
необязательно string
Исключить IP из отслеживания. Один на строку.
favorited_at
необязательно string
Добавлено в избранное :date в формате Y-m-dTH:i:s.
Обновить

API-точка доступа

PUT PATCH
https://vstat.org/api/v1/websites/{id}

Пример запроса

curl --location --request PUT 'https://vstat.org/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameters

Имя
Тип
Описание
privacy
необязательно integer
Конфиденциальность. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.
password
необязательно string
Пароль. Работает только с полем privacy, установленным в 2.
email
необязательно integer
Периодические отчеты по электронной почте. Возможные значения: 0 для Отключен, 1 для Включено.
exclude_bots
необязательно integer
Исключить обычных ботов из отслеживания. Возможные значения: 0 для Отключен, 1 для Включено.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. Один на строку.
exclude_ips
необязательно string
Исключить IP из отслеживания. Один на строку.
favorited_at
необязательно string
Добавлено в избранное :date в формате Y-m-dTH:i:s.
Удалить

API-точка доступа

DELETE
https://vstat.org/api/v1/websites/{id}

Пример запроса

curl --location --request DELETE 'https://vstat.org/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'