Веб-сайты

Заметки
Уровень эксперта
Ключ API должен быть отправлен в виде маркера Bearer в заголовке Authorization запроса. Получите ваш ключ API.
Список

Точка доступа API:

GET 
https://mhub.store/api/v1/websites

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

curl --location --request GET 'https://mhub.store/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательно string
Поисковый запрос.
search_by
необязательно string
Искать по. Возможные значения: domain для Домен. По умолчанию: domain.
favorite
необязательно boolean
Фильтровать по избранному.
sort_by
необязательно string
Сортировать по. Возможные значения: id для Дата создания, domain для Домен. По умолчанию: id.
sort
необязательно string
Sort. Возможные значения: desc для Descending, asc для Ascending. По умолчанию: desc.
per_page
необязательно integer
Результатов на страницу. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

Точка доступа API:

GET 
https://mhub.store/api/v1/websites/{id}

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

curl --location --request GET 'https://mhub.store/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Хранить

Точка доступа API:

POST 
https://mhub.store/api/v1/websites

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

curl --location --request POST 'https://mhub.store/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Параметр
Тип
Описание
domain
обязательно string
Имя домена
privacy
необязательно integer
Конфиденциальность. Возможные значения: 0 для Публично, 1 для Приватно, 2 для Пароль. По умолчанию: 0.
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-адреса из отслеживания. Один на строку..
Обновить

Точка доступа API:

PUT PATCH 
https://mhub.store/api/v1/websites/{id}

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

curl --location --request PUT 'https://mhub.store/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
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-адреса из отслеживания. Один на строку..
favorite
необязательно boolean
Избранное.
Удалить

Точка доступа API:

DELETE 
https://mhub.store/api/v1/websites/{id}

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

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