PmaControl — programiści i API
Szybki start
Odpytuj poniższe zasoby publiczne za pomocą curl. To API tylko do odczytu nie wymaga konta, formularza handlowego ani klucza API. Odpowiedzi są w formacie 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
Uwierzytelnianie i uprawnienia
Zasoby informacyjne i publiczna piaskownica pozostają dostępne bez poświadczeń. Aby przetestować uwierzytelnioną integrację, samodzielnie zarejestruj poufnego klienta OAuth w /oauth/register, a następnie pobierz token client_credentials w /oauth/token. Zakresy sandbox.servers.read i sandbox.identity.read są zadeklarowane w OpenAPI i egzekwowane na chronionych trasach. Sekret klienta wygasa po 24 godzinach, a token po maksymalnie 600 sekundach. Poświadczenia nie dają dostępu do instalacji klientów; ich dostęp jest administrowany oddzielnie.
Kontrakt i błędy
Kontrakt OpenAPI opisuje każdą operację, parametry i odpowiedzi. Błędy API używają application/problem+json. Limit publiczny wynosi 300 żądań na adres IP w ciągu 60 sekund. RateLimit-Policy i RateLimit określają politykę, pozostałą kwotę i sekundy do odnowienia; dla zgodności dostępne są również RateLimit-Limit, RateLimit-Remaining i RateLimit-Reset. Po HTTP 429 odczekaj liczbę sekund z Retry-After. Pola są zgodne z projektem IETF httpapi-ratelimit-headers-11; dostępność nie jest gwarantowana.
Bezpłatna piaskownica
Przetestuj syntetyczną odpowiedź MariaDB / MySQL bez konta ani klucza. Metryki to stałe przykłady bez połączenia z bazami klientów. Piaskownica jest tylko do odczytu i nie symuluje uprawnień produkcyjnych. Istniejący okres próbny Pro wymaga weryfikacji email i UUID instalacji; licencja nie jest kluczem API.
curl -sS https://www.pmacontrol.com/api/v1/sandbox/servers
Oficjalne CLI PmaControl
Zainstaluj CLI z oficjalnego tap Homebrew na macOS lub Linuksie. Formuła używa Python 3.13 i weryfikuje SHA-256 opublikowanego archiwum źródłowego. Polecenia capabilities, permissions, schema, docs i sandbox zwracają JSON bez konta ani klucza. Pakiet i kod źródłowy są publicznie dostępne w tej witrynie.
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
Samodzielne uzyskanie poświadczeń piaskownicy
Poniższy proces tworzy identyfikator i sekret klienta bez rejestracji konta ani płatności, a następnie token ograniczony do sandbox.servers.read. Zastąp CLIENT_ID, CLIENT_SECRET i ACCESS_TOKEN zwróconymi wartościami. Aby sprawdzić tożsamość klienta, jawnie zażądaj sandbox.identity.read. Limit rejestracji wynosi pięciu klientów na godzinę na IP i 120 na godzinę dla usługi; token endpoint przyjmuje 30 żądań na minutę na IP. Aktualne nagłówki kwoty i Retry-After mają pierwszeństwo.
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'
Przewodnik startowy dla programów
Wersjonowanie i wycofywanie API
REST API v1 jest aktywne, a bieżący kontrakt ma wersję 1.1.0. Zgodne rozszerzenia używają wersji podrzędnej, a zmiany niezgodne wymagają nowego głównego adresu, np. /api/v2. Wycofanie v1 nie jest planowane. Przed wycofaniem publikujemy datowane powiadomienie i przewodnik migracji z co najmniej 90-dniowym wyprzedzeniem, z wyjątkiem udokumentowanych pilnych wymogów bezpieczeństwa lub prawa.
Przy wycofywaniu zasobu Deprecation zawiera datę strukturalną RFC 9745 w postaci @Unix_seconds, a Sunset datę HTTP wyłączenia w GMT zgodnie z RFC 8594. Sunset nie może poprzedzać Deprecation. Łącze HTTP rel=deprecation prowadzi do tej polityki i instrukcji migracji. Aktywne zasoby udostępniają łącze bez fikcyjnej daty wyłączenia.