API walidacji OSCAL

Wyślij dokument OSCAL 1.2.2 JSON metodą POST i otrzymaj raport walidacji w formacie do odczytu maszynowego, przygotowany przez ten sam mechanizm co walidator w przeglądarce i przeznaczony do potoków CI, agentów oraz integracji. Konto nie jest wymagane.

Przetwarzanie tymczasowe, bez przechowywania. Dokument jest walidowany w pamięci na serwerach w UE (Frankfurt), a następnie usuwany wraz z odpowiedzią. Secani nie utrwala, nie zapisuje w logach ani nie wykorzystuje ponownie jego treści; telemetria obejmuje wyłącznie dane zbiorcze.

curl -sS -X POST https://secani.com/api/oscal/v1/validate \
  -H "content-type: application/json" \
  --data-binary @system-security-plan.json

Duże artefakty bardzo dobrze się kompresują. Wyślij je z użyciem gzip, aby zmieścić się w limicie transferu 4 MB:

gzip -c catalog.json | curl -sS -X POST https://secani.com/api/oscal/v1/validate \
  -H "content-type: application/json" \
  -H "content-encoding: gzip" \
  --data-binary @-

Co zespoły budują za pomocą API

Kontrola scaleń w CI

Waliduj SSP, profile i definicje komponentów w repozytorium przy każdym pull requeście. Steruj przebiegiem na podstawie pola valid i przechodź bezpośrednio do każdego problemu za pomocą jego wskaźnika JSON Pointer RFC 6901.

Samokorygujący agenci AI

Agenci generujący lub edytujący OSCAL mogą walidować w pętli: utworzyć dokument, odczytać problemy z precyzyjnymi wskaźnikami, poprawić go i ponownie zwalidować — bez udziału człowieka w cyklu naprawy.

Narzędzia przeglądarkowe bez backendu

CORS jest otwarty, dlatego wewnętrzne narzędzia internetowe mogą wysyłać dokumenty metodą POST bezpośrednio z przeglądarki, na przykład w celu sprawdzenia definicji komponentu dostarczonej przez partnera przed jej zaakceptowaniem.

Jak działa kontrakt v1

Dokument jest treścią żądania

Wyślij bezpośrednio dokument OSCAL 1.2.2 JSON metodą POST, bez dodatkowej obudowy i bez konta. Wszystkie osiem modeli jest rozpoznawanych na podstawie klucza głównego. Zakończona walidacja zawsze zwraca HTTP 200; nieprawidłowe dokumenty zawierają valid: false.

Obsługa dużych dokumentów

Do 4 MB danych surowych w transferze i 24 MB po rozpakowaniu dla żądań gzip. Pełny katalog NIST SP 800-53 jest walidowany w czasie znacznie krótszym niż 100 milisekund.

Wszystko w formacie do odczytu maszynowego

Do 200 problemów z dokładną łączną liczbą, stabilnymi kodami błędów RFC 9457, nagłówkami RateLimit i kontraktem OpenAPI 3.1 do generowania klientów.

Uczciwe limity anonimowe

10 żądań na minutę i 300 dziennie na klienta, wskazywane w nagłówkach odpowiedzi RateLimit. Klucz API podnosi ten limit do 120 na minutę i 10 000 dziennie; poziom anonimowy pozostaje dostępny.

Domyślnie API wykonuje rygorystyczną walidację OSCAL 1.2.2 za pomocą JSON Schema oraz udokumentowanej poprawki zgodności profili. Z parametrem level=full dodaje sprawdzanie ograniczeń i odwołań, a każda odpowiedź wskazuje dokładny zastosowany zestaw reguł, dzięki czemu zapisany raport staje się odtwarzalnym poświadczeniem.

Najczęstsze pytania o API walidacji OSCAL

Waliduje dokumenty OSCAL 1.2.2 JSON przez HTTP. Wyślij sam dokument jako treść żądania POST i otrzymaj raport do odczytu maszynowego z tego samego mechanizmu co walidator w przeglądarce, przeznaczony do potoków CI, agentów i integracji.

Nie. Korzystanie anonimowe jest bezpłatne i nie wymaga konta. Żądania anonimowe są ograniczone do 10 na minutę i 300 dziennie na klienta, co wskazują nagłówki odpowiedzi RateLimit.

Aby uzyskać wyższe limity, administrator organizacji tworzy klucz API w ustawieniach organizacji. Wysyłany w nagłówku Authorization: Bearer podnosi limity do 120 żądań na minutę i 10 000 dziennie. Klucz pozwala wyłącznie na walidację i nie daje dostępu do obszarów roboczych ani dowodów; nieznany lub unieważniony klucz zwraca 401 zamiast przejść na dostęp anonimowy.

OSCAL 1.2.2 JSON we wszystkich ośmiu modelach, rozpoznawanych na podstawie klucza głównego, po jednym dokumencie na żądanie. Treść żądania może mieć do 4 MB w postaci surowej lub 24 MB po rozpakowaniu przy wysyłce z gzip. Formaty XML i YAML nie są akceptowane.

Nie. Każdy dokument jest walidowany w pamięci na serwerach w UE we Frankfurcie i usuwany wraz z odpowiedzią. Secani nie utrwala, nie zapisuje w logach ani nie wykorzystuje ponownie jego treści; telemetria obejmuje wyłącznie dane zbiorcze.

Dokumentacja API opisuje żądania, odpowiedzi, limity, klucze API i wszystkie kody błędów. Dostępny jest też kontrakt OpenAPI 3.1 do generowania klientów. Przeczytaj dokumentację API

Wolisz zweryfikować dokument ręcznie?

Walidator w przeglądarce wykonuje te same kontrole całkowicie lokalnie; dokument nigdy nie opuszcza przeglądarki.