PmaControl — разработчикам и API
Быстрый старт
Запрашивайте общедоступные ресурсы ниже с помощью curl. Для этого API только для чтения не нужны учётная запись, обращение в отдел продаж или ключ API. Ответы имеют формат JSON.
curl -sS https://www.pmacontrol.com/api/v1/capabilities
curl -sS 'https://www.pmacontrol.com/api/v1/documentation?language=en'
curl -sS https://www.pmacontrol.com/api/v1/permissions
Аутентификация и разрешения
Ресурсы обнаружения и публичная песочница остаются доступны без учётных данных. Для проверки интеграции с аутентификацией самостоятельно зарегистрируйте конфиденциальный OAuth-клиент в /oauth/register и получите токен client_credentials в /oauth/token. Области sandbox.servers.read и sandbox.identity.read объявлены в OpenAPI и проверяются на защищённых маршрутах. Секрет клиента действует 24 часа, токен — не более 600 секунд. Эти данные не дают доступа к установкам клиентов, которые администрируются отдельно.
Контракт и ошибки
Контракт OpenAPI описывает операции, параметры и ответы. Ошибки API используют application/problem+json. Публичный лимит — 300 запросов с одного IP-адреса за 60 секунд. RateLimit-Policy и RateLimit сообщают политику, остаток квоты и секунды до сброса; для совместимости доступны RateLimit-Limit, RateLimit-Remaining и RateLimit-Reset. После HTTP 429 подождите число секунд из Retry-After. Поля следуют проекту IETF httpapi-ratelimit-headers-11; гарантия доступности не предоставляется.
Бесплатная песочница
Проверьте синтетический ответ MariaDB / MySQL без учётной записи или ключа. Метрики являются фиксированными примерами без подключения к базам клиентов. Песочница доступна только для чтения и не моделирует производственные разрешения. Существующая пробная версия Pro требует подтверждения email и UUID установки; лицензия не является ключом API.
curl -sS https://www.pmacontrol.com/api/v1/sandbox/servers
Официальная CLI PmaControl
Установите CLI из официального tap Homebrew на macOS или Linux. Формула использует Python 3.13 и проверяет SHA-256 опубликованного архива исходного кода. Команды capabilities, permissions, schema, docs и sandbox возвращают JSON без учётной записи или ключа. Пакет и его исходный код доступны публично на этом сайте.
brew tap pmacontrol/agent https://www.pmacontrol.com/downloads/homebrew-agent.git
brew install pmacontrol/agent/pmacontrol-agent
pmacontrol-agent --version
pmacontrol-agent capabilities
pmacontrol-agent docs --language fr
pmacontrol-agent sandbox
Самостоятельное получение данных доступа к песочнице
Этот процесс создаёт идентификатор и секрет клиента без регистрации или оплаты, затем токен только с sandbox.servers.read. Замените CLIENT_ID, CLIENT_SECRET и ACCESS_TOKEN полученными значениями. Для проверки идентичности клиента явно запросите sandbox.identity.read. Регистрация ограничена пятью клиентами в час на IP и 120 клиентами в час для сервиса; token endpoint принимает 30 запросов в минуту на IP. Следуйте актуальным заголовкам квоты и Retry-After.
curl -sS https://www.pmacontrol.com/oauth/register \
-H 'Content-Type: application/json' \
--data '{"grant_types":["client_credentials"],"response_types":[],"scope":"sandbox.servers.read"}'
curl -sS https://www.pmacontrol.com/oauth/token \
--user 'CLIENT_ID:CLIENT_SECRET' \
--data 'grant_type=client_credentials&scope=sandbox.servers.read'
curl -sS https://www.pmacontrol.com/api/v1/sandbox/authorized-servers \
-H 'Authorization: Bearer ACCESS_TOKEN'
Машиночитаемое руководство по подключению
Версии API и прекращение поддержки
REST API v1 активен, текущая версия контракта — 1.1.0. Совместимые дополнения используют минорную версию, несовместимые изменения требуют нового URL основной версии, например /api/v2. Вывод v1 из эксплуатации не запланирован. Перед отключением мы публикуем датированное уведомление и руководство по миграции минимум за 90 дней, кроме документированных срочных требований безопасности или закона.
При прекращении поддержки ресурса Deprecation содержит структурированную дату RFC 9745 в виде @Unix_seconds, а Sunset — HTTP-дату отключения в GMT по RFC 8594. Sunset никогда не предшествует Deprecation. HTTP-ссылка rel=deprecation ведёт к этой политике и инструкциям по миграции. Активные ресурсы публикуют ссылку без вымышленной даты отключения.