Dokumentacja API
Kompletna dokumentacja API Polylane jest hostowana obok samej platformy:
Otwórz dokumentację API
Każda operacja, kształt żądania i odpowiedzi oraz fragmenty żądań do skopiowania. Generowana ze specyfikacji OpenAPI, którą serwuje platforma, więc pozostaje zsynchronizowana z każdym wydaniem.
Uwierzytelnianie
Uwierzytelniaj żądania jednym z:
x-api-key: <api-key>dla kluczy API obszaru roboczego.Authorization: Bearer <access-token>dla tokenów dostępu OAuth.
Klucze API tworzysz i klientów OAuth rejestrujesz w konsoli. Zobacz Klucze API i OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Format odpowiedzi
Każda odpowiedź JSON używa tej samej koperty. Odpowiedzi udane ustawiają success: true i umieszczają ładunek pod result:
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Odpowiedzi błędne ustawiają success: false i opisują niepowodzenie pod error:
{
"success": false,
"message": null,
"error": { "message": "Unauthorized", "detail": "Invalid API key" }
}
Limity żądań
Każde poświadczenie (klucz API, token OAuth lub IP klienta dla tras nieuwierzytelnionych) jest ograniczone do 5,000 żądań na 60 sekund w całym REST API. Każda odpowiedź ogłasza politykę nagłówkami RateLimit z projektu IETF:
RateLimit-Limit: 5000
RateLimit-Policy: 5000;w=60
Po przekroczeniu limitu API odpowiada 429 i nagłówkiem Retry-After niosącym długość okna w sekundach. Odczekaj, aż upłynie, a potem ponów próbę.
Serwer MCP platformy ma własny budżet 600 żądań na 60 sekund na poświadczenie i ogłasza go tymi samymi nagłówkami.
Z wiersza poleceń
Każda operacja API jest wywoływalna z interfejsu wiersza poleceń Polylane (CLI), łącznie z operacjami bez pełnoprawnego polecenia:
polylane api list # every operation
polylane api describe workspaces.list # request and response shape
polylane api call issues.list --query '{"active":true,"severity":"critical"}'
polylane api call przyjmuje --body '<json>' dla treści żądania, --body-file <path> do odczytu treści z pliku i --query '<json>' dla parametrów zapytania.
Klient CLI jest generowany z tej samej specyfikacji OpenAPI co hostowana dokumentacja, więc każda operacja, którą tam znajdziesz, jest bezpośrednio wywoływalna. Uwierzytelnij go kluczem API przez polylane auth login --api-key sk_... albo uruchom polylane auth login dla przepływu w przeglądarce. Zobacz uwierzytelnianie CLI.