API

HTTP API dla projektów, aplikacji i reszty platformy.

Każdy zasób widoczny w dashboardzie ma endpoint HTTP. Korzystaj z niego z poziomu CLI, w CI, w skryptach lub z dowolnego klienta, który potrafi wysłać JSON.

• Bazowy URL: https://api.nodion.com
• Interaktywna dokumentacja: api.nodion.com/v2/docs
• OpenAPI: api.nodion.com/v2/openapi.yaml

Uwierzytelnianie

Wysyłaj token typu Bearer w każdym żądaniu:

httpAuthorization: Bearer nodion_…

Są dwa rodzaje tokenów:

• Osobiste klucze API (nodion_…) działają w Twoim imieniu. Wybierasz zakresy uprawnień (scopes) i możesz ograniczyć klucz do wybranych projektów. Utworzysz je w Account → Security. Token jest wyświetlany tylko raz.
• Klucze projektu (nodion_proj_…) należą do projektu, a nie do osoby, więc CI działa dalej, gdy ktoś odejdzie z zespołu. Utworzysz je w zakładce API keys projektu.

Zakresy osobistego klucza:

• read: wyświetlanie list i pobieranie zasobów
• write: tworzenie, zmiana i usuwanie
• deploy: uruchamianie wdrożeń
• env:read / env:write: wartości zmiennych środowiskowych
• logs:read: logi aplikacji

Operacje odczytu wymagają read, operacje zapisu write, chyba że dana operacja wymaga węższego zakresu (na przykład deploy). Klucze projektu nie mają zakresów. Dają pełny dostęp do swojego projektu. Rozliczeniami i 2FA zarządzasz w dashboardzie; klucze API nie dają do nich dostępu.

Wybór projektu

Zagnieżdżone ścieżki mają postać /v2/projects/{id}/…. Jeśli pracujesz w jednym projekcie, użyj krótkiej ścieżki i wyślij ID projektu w nagłówku:

httpX-Nodion-Project: prj_…

Pierwsze żądanie

bashcurl https://api.nodion.com/v2/applications \
  -H "Authorization: Bearer $NODION_TOKEN" \
  -H "X-Nodion-Project: $NODION_PROJECT"

Uruchom wdrożenie (wymaga zakresu deploy w osobistym kluczu):

bashcurl -X POST https://api.nodion.com/v2/applications/$APP_ID/deployments \
  -H "Authorization: Bearer $NODION_TOKEN"

Listy, błędy i limity

Odpowiedzi z kolekcjami mają postać { "data": [ … ], "next_cursor": null }. Aby przejść do kolejnej strony, przekaż ?limit= oraz poprzedni next_cursor jako ?cursor=.

Błędy są zwracane zgodnie z RFC 9457 (application/problem+json) ze stabilnym polem code i polem request_id. Podaj to ID, gdy kontaktujesz się z supportem. Publiczny katalog błędów jest pod adresem GET /v2/errors.

Wywołania uwierzytelnione kluczem podlegają rate limitowi dla całego konta. Odpowiedzi zawierają RateLimit-Limit, RateLimit-Remaining i RateLimit-Reset. Odpowiedź 429 zawiera też Retry-After. Każda odpowiedź ma X-Request-Id.

Treści żądań i konsolę do testowania wywołań znajdziesz w interaktywnej dokumentacji. Poniższe strony opisują te same endpointy w formacie tej witryny.

Endpointy

Lista wygenerowana z publicznego dokumentu OpenAPI. 278 operacji, pogrupowanych jak w specyfikacji.