Uruchom sprawdzenie zgodności ze standardem za pomocą Connect

W skrócie

Użyj tego przepisu, aby za pośrednictwem transportów Connect ocenić plik PDF względem zestawu reguł wskazanego standardu. Przykłady to PDF/A-4, poziom baseline standardu PDF Advanced Electronic Signatures (PAdES) lub polityka organizacyjna. Narzędzie compliance-check należy do poziomu Enterprise. Serwer wykrywa je za pomocą sondy class_exists() i rejestruje tylko wtedy, gdy wraz z serwerem zainstalowany jest pakiet nextpdf/premium. W instalacji opartej wyłącznie na open source narzędzie jest nieobecne, a wywołanie kończy się błędem nieznanego narzędzia.

Narzędzie zgłasza wynik pass/fail dla każdej reguły, którą implementuje dla żądanego standardu. Wynik ten jest własnym sprawdzeniem narzędzia, a nie niezależną certyfikacją zgodności. O zgodności rozstrzyga walidator, taki jak veraPDF dla PDF/A. Ta strona opisuje zachowanie narzędzia, a nie gwarancję zgodności.

Instalacja

composer require nextpdf/server

Potwierdź za pomocą wywołania tools/list, że narzędzie zgodności Enterprise jest dostępne w działającym wdrożeniu. Zobacz /connect/tool-catalog/.

Przegląd koncepcyjny

Standard, taki jak PDF/A-4, określa wymagania wobec dokumentu. Narzędzie sprawdzające ocenia dokument względem tych wymagań (PDF/A-4 §6.2.3). Zgodność rozstrzyga się względem wymagań standardu, a nie deklaracji oprogramowania, które utworzyło dokument (PDF/A-4 §6.7.3). W przypadku standardów związanych z podpisem sprawdzenie ustala, czy po podpisaniu wystąpiła modyfikacja w odniesieniu do podpisanego zakresu bajtów (ISO 32000-2 §12.8).

Wynik „pass” z narzędzia oznacza, że żadna reguła, którą narzędzie implementuje dla tego standardu, nie zakończyła się niepowodzeniem. Wynik ten jest węższy niż formalna certyfikacja zgodności całego dokumentu.

Powierzchnia API

Zweryfikuj nazwy narzędzi względem działającego rejestru za pomocą tools/list. Katalog referencyjny znajduje się w /connect/tool-catalog/. Ten przepis nie podaje liczby narzędzi, ponieważ jest ona właściwością wdrożenia w czasie wykonywania.

Przykład kodu — szybki start

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "compliance_check",
    "arguments": { "document_id": "<id>", "standard": "pdfa-4" }
  }
}

Przykład kodu — produkcja

Traktuj wynik „fail” jako dane umożliwiające podjęcie działania. Odróżnij awarię transportu od zwykłego statusu Hypertext Transfer Protocol (HTTP), który sygnalizuje niepowodzenie:

curl -sS -X POST https://connect.example.com/v1/tools/compliance_check \
  -H 'Authorization: Bearer '"$NEXTPDF_CONNECT_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"source":"/var/lib/nextpdf/in/report.pdf","standard":"pdfa-4"}' \
  -o /tmp/check.json -w '%{http_code}' > /tmp/check-status || {
    echo "transport failure invoking compliance_check" >&2; exit 1; }

[ "$(cat /tmp/check-status)" = "200" ] || {
  echo "compliance_check returned non-200; inspect /tmp/check.json" >&2; }

Odpowiedź wymienia każdą ocenioną regułę, jej status pass/fail oraz przyczynę każdego niepowodzenia. Wykorzystaj te niepowodzenia, aby ukierunkować naprawę. Nie traktuj wyniku „pass” jako certyfikacji.

Przypadki brzegowe i pułapki

Nieznana nazwa standardu. Narzędzie zwraca błąd nieznanego standardu wraz z rozpoznawanymi identyfikatorami. Użyj dokładnego identyfikatora (pdfa-4, identyfikatora poziomu baseline PAdES, identyfikatora polityki organizacyjnej).
Nie znaleziono dokumentu. Sprawdź, czy document_id pochodzi z wcześniejszego wywołania zwracającego wynik, albo przekaż prawidłową ścieżkę source.
Uszkodzona tablica odsyłaczy. Niepowodzenie parsowania oznacza, że dane wejściowe nie są poprawnym plikiem PDF albo są obcięte. Wygeneruj źródło ponownie.
Brak narzędzia. Bez nextpdf/premium narzędzie zgodności Enterprise nie jest zarejestrowane, a wywołanie kończy się błędem nieznanego narzędzia.

Wydajność

Budżet w front matter jest limitem dokumentacyjnym, a nie gwarancją poziomu usług.

Uwagi dotyczące bezpieczeństwa

Nie loguj ścieżki źródłowej ani pełnego raportu na poziomie logów wysyłanym na zewnątrz. Loguj nazwę narzędzia, identyfikator żądania oraz ogólny wynik pass/fail. Wynik „pass” opisuje zestaw reguł, który narzędzie implementuje, a nie gwarancję w zakresie bezpieczeństwa ani kwestii prawnych.

Zgodność ze standardem

Stwierdzenie	Klauzula	reference_id
Standard określa wymagania, a narzędzie sprawdzające je ocenia	PDF/A-4 §6.2.3
Zgodność rozstrzyga się względem wymagań, a nie deklaracji producenta	PDF/A-4 §6.7.3
Modyfikacja po podpisaniu jest wykrywalna względem podpisanego zakresu bajtów	ISO 32000-2 §12.8

Obsługa sprawdzenia zgodności ze standardem nie jest certyfikacją zgodności. O zgodności rozstrzyga niezależny walidator.

Kontekst komercyjny

Narzędzie compliance-check należy do poziomu Enterprise. Jest rejestrowane tylko wtedy, gdy wraz z serwerem zainstalowany jest pakiet nextpdf/premium.

Specyfika Connect

Dostępność transportu (MCP / REST / gRPC)

Wywołuj narzędzie tak samo przez Model Context Protocol (MCP) tools/call, punkt końcowy narzędzia Representational State Transfer (REST) oraz usługę gRPC za pośrednictwem wspólnego wykonawcy narzędzi.

Poziom ryzyka HITL

Sprawdzenie jest tylko do odczytu i domyślnie nie ma ustawionego approval_required. Nadpisanie przez operatora może podnieść poziom ryzyka sprawdzenia. Nadpisanie może wyłącznie podnieść poziom; nigdy go nie obniża. Zobacz /connect/hitl-risk-tiers/.

Koperta JSON bramki potwierdzenia

Narzędzie nie uruchamia bramki, dopóki nadpisanie przez operatora nie podniesie poziomu do approval_required. Koperta wyzwania oraz kontrakt tokenu jednorazowego są udokumentowane w /connect/hitl-risk-tiers/.

Zobacz także

/cookbook/connect/batch-compliance/ — uruchom sprawdzenie dla wielu dokumentów.
/cookbook/connect/ai-ready-certification/ — uruchom szersze sprawdzenie gotowości do AI.
/connect/tool-catalog/ — zobacz, jak wyznaczany jest zestaw narzędzi dla każdego poziomu.
/connect/hitl-risk-tiers/ — przejrzyj model ryzyka i bramkę.