API-интерфейс

Интерфейс API-функций PrivateFlare позволяет работу с доменами. Взаимодействие с сервисом осуществляется по протоколу HTTP REST API. Формат запроса и результата - JSON. Ограничений на количество запросов нет.

Авторизация

Для авторизации необходимо передать заголовок X-Auth-Key со значением API ключа:

X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz

Чтобы получить ключ API, нажмите на свое имя в правом верхнем углу, выберите пункт "Get API key" и скопируйте ключ.

Спецификация

Базовый URL: https://api.privateflare.com

Запрос	Путь	Описание
GET	`/me`	Информация о пользователе
GET	`/domains/`	Список доменов
GET	`/domains/{domain}`	Детали по выбранному домену
POST	`/domains/`	Создать новый домен
PATCH	`/domains/{domain}`	Обновить параметры домена
DELETE	`/domains/{domain}`	Удалить домен

Информация о пользователе

URL: GET https://api.privateflare.com/me

Функция возвращает информацию о пользователе, его баланс и доступные слоты.

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

curl --location 'https://api.privateflare.com/me' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz'

Пример успешного ответа сервера:

{
    "name": "Meow Nyan",
    "slot_limit": 1000,
    "slot_used": 1,
    "user_token": "wl3ezSTggb9vmtnW98O3iceqFX3GN52q",
    "balance": 1.0,
    "api_key": "meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz",
    "success": true
}

Пример ошибочного ответа сервера:

{
   "success": false,
   "msg": "invalid api key"
}

Список доменов

URL: GET https://api.privateflare.com/domains/

Функция возвращает список активных доменов в поле domains. Каждый домен отображается как объект с полями, описанными в следующей функции.

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

curl --location 'https://api.privateflare.com/domains/' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz'

Пример успешного ответа сервера:

{
    "domains": [{
        "id": 12345,
        "enabled": true,
        "domain": "meow.life",
        "mask": "purr.me",
        "ssl": true,
        "backend": "51.15.14.88",
        "fhttps": true,
        "created": 1671273182,
        "online": true,
        "tags": [ "meow", "parked" ],
        "cachelevel": 0,
        "ratelimit": 1000,
        "serverheader": "",
        "imageconvert": false,
        "minify": false,
        "node": 123
    }],
    "success": true
}

Детали по выбранному домену

URL: GET https://api.privateflare.com/domains/{domain}

Функция возвращает данные выбранного домена в объекте domain с полями:

id - внутренний идентификатор домена.
enabled - флаг активности домена.
domain - адрес домена.
mask - маскируемый целевой домен.
ssl - флаг генерации SSL-сертификата.
backend - IP-адрес целевого сервера.
fhttps - флаг обязательного перехода на HTTPS.
created - время создания домена в формате UNIX timestamp.
online - текущий статус домена.
tags - массив с тегами.
cachelevel - уровень кеширования (0 - отключено, 1 - базовое, 2 - усиленное)
ratelimit - ограничение на количество запросов.
serverheader - заголовок сервера.
imageconvert - флаг активности конвертора картинок в WebP.
minify - флаг активности минификации JS, CSS и HTML.
node - идентификатор ноды, к которой привязан домен.

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

curl --location 'https://api.privateflare.com/domains/meow.life' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz'

Пример успешного ответа сервера:

{
    "domain": {
        "id": 12345,
        "enabled": true,
        "domain": "meow.life",
        "mask": "purr.me",
        "ssl": true,
        "backend": "51.15.14.88",
        "fhttps": true,
        "created": 1671273182,
        "online": true,
        "tags": [ "meow", "parked" ],
        "cachelevel": 0,
        "ratelimit": 1000,
        "serverheader": "",
        "imageconvert": false,
        "minify": false,
        "node": 123
    },
    "success": true
}

Пример ошибочного ответа сервера:

{
    "success": false,
    "msg": "domain not exists"
}

Создать новый домен

URL: POST https://api.privateflare.com/domains/

Функция создаёт новый домен по указанным данным:

enabled - флаг активности домена (true или false).
domain - адрес домена (строка).
mask - маскируемый целевой домен (строка).
ssl - флаг генерации SSL-сертификата (true или false).
backend - IP-адрес целевого сервера (строка).
fhttps - флаг обязательного перехода на HTTPS (true или false).
tags - массив с тегами (массив строк).
cachelevel - уровень кеширования (0 - отключено, 1 - базовое, 2 - усиленное)
ratelimit - ограничение на количество запросов (число).
serverheader - заголовок сервера (строка).
imageconvert - флаг активности конвертора картинок в WebP (true или false).
minify - флаг активности минификации JS, CSS и HTML (true или false).

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

curl --location 'https://api.privateflare.com/domains/' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz' \
--data '{
    "enabled": true,
    "domain": "meow.life",
    "mask": "purr.me",
    "ssl": true,
    "backend": "51.15.14.88",
    "fhttps": true,
    "tags": [ "meow", "parked" ],
    "cachelevel": 1
}'

Пример успешного ответа сервера:

{
    "success": true
}

Пример ошибочного ответа сервера:

{
    "success": false,
    "msg": "domain exists"
}

Обновить параметры домена

URL: PATCH https://api.privateflare.com/domains/{domain}

Функция меняет настройки домена. Список полей и методы отправки аналогичны функции создания домена. Вы можете передавать только те параметры, которые необходимо изменить.

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

curl --location --request PATCH 'https://api.privateflare.com/domains/meow.life' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz' \
--data '{
    "ssl": false,
    "fhttps": false,
    "cachelevel": 0
}'

Пример успешного ответа сервера:

{
    "success": true
}

Пример ошибочного ответа сервера:

{
    "success": false,
    "msg": "domain not exists"
}

Удалить домен

URL: DELETE https://api.privateflare.com/domains/{domain}

Функция удаляет домен по его названию.

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

curl --location --request DELETE 'https://api.privateflare.com/domains/meow.life' \
--header 'X-Auth-Key: meowyeVV9FEkGb2zRwNXetEeWVChrMky6Szz'

Пример успешного ответа сервера:

{
    "success": true
}

Пример ошибочного ответа сервера:

{
    "success": false,
    "msg": "domain not exists"
}