PmaControl — développeurs et API
Démarrage rapide
Interrogez les ressources publiques ci-dessous avec curl. Aucun compte, formulaire commercial ou clé API ne sont nécessaires pour cette API en lecture seule. Les réponses sont au format 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
Authentification et permissions
Les ressources de découverte et le bac à sable public restent accessibles sans identifiants. Pour tester une intégration authentifiée, enregistrez un client OAuth confidentiel en libre-service à /oauth/register puis demandez un jeton client_credentials à /oauth/token. Les scopes sandbox.servers.read et sandbox.identity.read sont déclarés dans OpenAPI et contrôlés sur les routes protégées. Le secret client expire après 24 heures et le jeton après au plus 600 secondes. Ces identifiants n’ouvrent aucune installation cliente ; ses accès restent administrés séparément.
Contrat et erreurs
Le contrat OpenAPI décrit chaque opération, ses paramètres et ses réponses. Les erreurs API utilisent application/problem+json. La limite publique est de 300 requêtes par adresse IP sur 60 secondes. RateLimit-Policy et RateLimit déclarent la politique, le quota restant et les secondes avant réinitialisation ; RateLimit-Limit, RateLimit-Remaining et RateLimit-Reset sont aussi fournis pour compatibilité. Après un statut 429, attendez les secondes de Retry-After. Ces champs suivent le brouillon IETF httpapi-ratelimit-headers-11 ; aucun engagement de disponibilité n’est promis.
Bac à sable gratuit
Testez une réponse synthétique MariaDB / MySQL sans compte ni clé. Les métriques sont des exemples fixes, sans connexion aux bases clientes. Ce bac à sable est en lecture seule et ne simule pas les permissions de production. L’essai Pro existant nécessite une validation email et un UUID ; sa licence n’est pas une clé API.
curl -sS https://www.pmacontrol.com/api/v1/sandbox/servers
CLI officielle PmaControl
Installez la CLI avec le tap Homebrew officiel sur macOS ou Linux. La formule utilise Python 3.13 et vérifie le SHA-256 de l’archive publiée. Les commandes capabilities, permissions, schema, docs et sandbox fournissent du JSON sans compte ni clé. Le paquet et ses sources sont accessibles publiquement sur ce site.
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
Identifiants de bac à sable en libre-service
Le parcours ci-dessous crée un identifiant et un secret client sans inscription ni paiement, puis un jeton limité à sandbox.servers.read. Remplacez CLIENT_ID, CLIENT_SECRET et ACCESS_TOKEN par les valeurs retournées. Pour tester l’identité du client, demandez explicitement sandbox.identity.read. La création est limitée à cinq clients par heure et par IP, et à 120 clients par heure pour le service ; le token endpoint accepte 30 requêtes par minute et par IP. Les compteurs courants et Retry-After font autorité.
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'
Versionnement et dépréciation
L’API REST v1 est active et le contrat courant est en version 1.1.0. Les ajouts compatibles utilisent une version mineure ; une rupture nécessite une nouvelle URL majeure, par exemple /api/v2. Aucun retrait de v1 n’est planifié. Avant un retrait, nous publions un avis daté et un guide de migration au moins 90 jours à l’avance, sauf urgence de sécurité ou obligation légale documentée.
Lorsqu’une ressource est dépréciée, Deprecation indique la date structurée RFC 9745 sous la forme @secondes_Unix et Sunset indique la date HTTP en GMT du retrait, selon RFC 8594. La date Sunset ne précède jamais Deprecation. Le lien HTTP rel=deprecation mène à cette politique et aux instructions de migration. Les ressources actives exposent ce lien sans annoncer de date fictive.
Politique API lisible par machine