API Astro: документация и примеры запросов

В этой статье разберём, что такое API прокси-сервиса (Application Programming Interface) и как он позволяет управлять прокси через HTTPS-запросы без использования интерфейса. Коротко объясним основные преимущества API и рассмотрим ключевые API-команды Astro и их назначение.

Это будет полезно, если вам нужно автоматизировать управление прокси, настроить интеграцию прокси-сервиса или работать с большим количеством прокси через API без ручных операций в интерфейсе.

Для знакомства с возможностями прокси-сервиса Astro новые пользователи могут получить тестовый баланс $3. Чтобы активировать его, свяжитесь со службой поддержки.

Что такое API для управления прокси и зачем он нужен

API (Application Programming Interface, интерфейс программирования приложения) позволяет взаимодействовать с прокси-сервисом напрямую через HTTPS-запросы – без ручной работы в интерфейсе. Это удобно для автоматизации, интеграций и управления большим количеством прокси. 

Преимущества и возможности API:

• автоматизация управления прокси без интерфейса;
• интеграция прокси-сервиса Astro в собственные системы;
• управление большим количеством прокси;
• оптимизация расхода трафика и затрат;
• снижение ручных операций и ошибок;
• выполнение действий через запросы в реальном времени.

Далее рассмотрим команды API Astro и разберём, какие возможности они предоставляют для интеграции сервиса с внешними системами и собственными инструментами автоматизации.

Получение баланса аккаунта

Метод позволяет получить текущий баланс аккаунта через API. Это удобно для автоматического мониторинга средств, интеграции с внутренними системами учёта или создания уведомлений о необходимости пополнения баланса.

Для получения информации необходимо отправить GET-запрос с API-токеном. В ответ сервис вернёт текущий баланс аккаунта и данные о валюте.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/balance

Обязательный параметр:

• token – API-токен для авторизации запроса.

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

{
    "status": "string",
    "data": {
        "balance": "number",
        "currency": "number"
    }
}

В случае успешного выполнения запроса значение поля balance будет содержать текущий остаток средств на аккаунте.

Получение списка портов

Этот метод позволяет получить список портов, доступных в аккаунте Astro. С его помощью можно выгружать данные о созданных прокси, отслеживать их параметры, объём использованного трафика и автоматически синхронизировать информацию с внешними системами.

Запрос поддерживает фильтрацию и сортировку результатов, что удобно при работе с большим количеством портов.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/ports

Обязательный параметр:

• token – API-токен для авторизации запроса.

Дополнительные параметры:

• count – количество записей в ответе.
• order – поле сортировки. Поддерживаются значения: random, created, id, name.

По умолчанию используется сортировка по id.

• orderDirection – направление сортировки:  asc или  desc. По умолчанию  desc.
• status – статус портов;
• active – только активные порты;
• archived – архивные порты.

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

{
    "id": "integer",
    "name": "string",
    "country": "string",
    "city": "string",
    "network": "string",
    "operator": "string",
    "node": {
        "ip": "string",
        "address": "string"
    },
    "ports": {
        "http": "integer",
        "socks": "integer"
    },
    "traffic": {
        "total": "integer",
        "used": "integer",
        "left": "integer"
    },
    "vpn": "string"
}

В ответе возвращается подробная информация о каждом порте, включая его идентификатор, название, геолокацию, сетевые параметры, адрес узла подключения, номера HTTP- и SOCKS-портов, а также статистику использования трафика.

Создание нового порта

Метод позволяет создать новый порт с указанными параметрами.

Метод: POST

Endpoint: https://astroproxy.com/api/v1/ports

Параметры запроса:

• token – API-токен.
• name – название порта.
• network – тип сети.
• country – страна.
• city – город.
• rotation_by – тип ротации (time, link, request).
• rotation_time_type – тип периода ротации (hours, minutes).
• rotation_time – время ротации.
• is_unlimited – флаг безлимитного трафика на порту.
• volume – объём трафика.
• username  – логин для доступа.
• password – пароль для доступа.
• ip – список IP-адресов для доступа по IP.
• use_tls – TLS Crypt.
• exclude_countries  – список стран для исключения (если страна не выбрана).
• include_countries – список стран для добавления (если страна выбрана).

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

{
    "id": "integer",
    "name": "string",
    "country": "string",
    "city": "string",
    "network": "string",
    "operator": "string",
    "node": {
        "ip": "string",
        "address": "string"
    },
    "ports": {
        "http": "integer",
        "socks": "integer"
    },
    "traffic": {
        "total": "integer",
        "used": "integer",
        "left": "integer"
    },
    "vpn": "string"
}

Удаление порта по ID

Метод позволяет удалить порт по его идентификатору.

Метод: DELETE

Endpoint: https://astroproxy.com/api/v1/ports/{id}

Параметры запроса:

• token – API-токен.
• id – идентификатор порта.

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

{
    "status": "string",
    "data": {
        "balance": "number",
        "currency": "number"
    }

}

Обновление порта

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

Метод: PATCH

Endpoint: https://astroproxy.com/api/v1/ports/{id}

Параметры запроса:

• token – API-токен.
• id – идентификатор порта.

Параметры тела запроса:

• name – название порта.
• vpn – использование конфига в туннельном режиме (android, ios, windows, macos, mikrotik).
• rotation_by – тип ротации (time, link, request).
• rotation_time_type – тип периода ротации (hours, minutes).
• rotation_time – время ротации.
• is_unlimited – флаг безлимитного трафика на порту.
• username – логин для доступа (если не используется IP).
• password – пароль для доступа (если не используется IP).
• exclude_countries – список стран для исключения (если страна не выбрана).
• include_countries – список стран для добавления (если страна выбрана).

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

{
    "id": "integer",
    "name": "string",
    "country": "string",
    "city": "string",
    "network": "string",
    "operator": "string",
    "node": {
        "ip": "string",
        "address": "string"
    },
    "ports": {
        "http": "integer",
        "socks": "integer"
    },
    "traffic": {
        "total": "integer",
        "used": "integer",
        "left": "integer"
    },
    "vpn": "string"
}

Продление порта

Метод позволяет продлить порт по его идентификатору.

Метод: POST

Endpoint: https://astroproxy.com/api/v1/ports/{id}/renew

Параметры запроса:

• token – API-токен.
• id – идентификатор порта.

Параметры тела запроса:

• volume – объём трафика.

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

{
    "status": "string",
    "data": {
        "id": "integer",
        "name": "string",
        "country": "string",
        "city": "string",
        "network": "string",
        "operator": "string",
        "node": {
            "ip": "string",
            "address": "string"
        },
        "ports": {
            "http": "integer",
            "socks": "integer"
        },
        "traffic": {
            "total": "integer",
            "used": "integer",
            "left": "integer"
        },
        "vpn": "string"
    }

}

Получение нового внешнего IP для порта

Метод позволяет получить новый внешний IP-адрес для указанного порта.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/ports/{id}/newip

Параметры запроса:

• token – API-токен.
• id – идентификатор порта клиента.

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

{
    "status": "string",
    "data": {
        "ip": "string"
    }
}

Пример ответа (HTTP 423):

{
    "status": "string",
    "data": {
        "message": "string"
    }

}

Получение нового внешнего IP для порта

Метод позволяет получить новый внешний IP-адрес для указанного порта.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/ports/{id}/newip

Параметры запроса:

• token – API-токен.
• id – идентификатор порта клиента.

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

{
    "status": "string",
    "data": {
        "ip": "string"
    }
}

Пример ответа (HTTP 423):

{
    "status": "string",
    "data": {
        "message": "string"
    }

}

Получение списка доступных стран

Метод позволяет получить список стран, доступных для указанного типа сети.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/countries

Параметры запроса:

• token – API-токен.
• network – тип сети.

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

{
    "status": "string",
    "data": {
        "name": "string"
    }

}

Получение списка доступных городов

Метод позволяет получить список городов для указанной страны.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/cities

Параметры запроса:

• token – API-токен.
• country – страна.

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

{
    "status": "string",
    "data": {
        "name": "string"
    }

}

Получение списка доступных операторов

Метод позволяет получить список операторов для указанных страны, города и типа сети.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/operators

Параметры запроса:

• token – API-токен.
• country – страна.
• city – город.
• network – тип сети.

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

{
    "status": "string",
    "data": {
        "name": "string"
    }

}

Получение структурированного списка стран, городов и операторов

Метод позволяет получить структурированный список стран, городов и операторов.

Метод: GET

Endpoint: https://astroproxy.com/api/v1/lists

Параметры запроса:

• token – API-токен.

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

{
    "status": "string",
    "data": {
        "countries": {
            "name": "string",
            "code": "string",
            "cities": {
                "name": "string",
                "operators": {
                    "name": "string"
                }
            }
        }
    }

}

Расчёт стоимости порта

Метод позволяет рассчитать стоимость порта на основе указанных параметров.

Метод: POST

Endpoint: https://astroproxy.com/api/v1/calculate

Параметры тела запроса:

• name – название порта.
• network – тип сети.
• country – страна.
• city – город.
• rotation_by – тип ротации (time, link, request).
• rotation_time_type – тип периода ротации (hours, minutes).
• rotation_time – время ротации.
• is_unlimited – флаг безлимитного трафика на порту.
• volume – объём трафика.
• username – логин для доступа.
• password – пароль для доступа.
• ip – список IP-адресов для доступа по IP.

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

{
    "status": "string",
    "data": {
        "cost": "number",
        "currency": "string"
    }
}

Заключение

API Astro предоставляет возможность автоматизировать основные операции по управлению портами и работе с сервисом. Ваш уникальный API-ключ находится в личном кабинете в разделе настроек API.

Все запросы к API Astro должны выполняться через HTTPS. Для каждого метода в личном кабинете доступны примеры на PHP, а также возможность выполнить тестовый запрос непосредственно из интерфейса аккаунта и сразу получить результат выполнения.

Если у вас возникли вопросы, свяжитесь с нашей службой поддержки.