Exakta endpoints beror på installerad flavor, aktiverade verktyg och säkerhetskonfiguration. Utgå alltid från OpenAPI-dokumentet i din egen instans.
Hitta API-dokumentationen
På en lokal standardinstallation finns Swagger UI på http://localhost:8081/swagger-ui/index.html och OpenAPI JSON på /v3/api-docs.
Grundmönster
- 1
Läs OpenAPI
Kontrollera endpoint, multipart-fältnamn, tillåtna värden och svarstyp i just din version.
- 2
Skicka fil och parametrar
De flesta verktyg använder multipart/form-data med fileInput och verktygsspecifika fält.
- 3
Validera svaret
Kontrollera HTTP-status, Content-Type, filsignatur, sidantal och eventuella ZIP-poster innan resultatet flyttas vidare.
- 4
Logga utan innehåll
Logga jobb-id, endpoint, storlek, varaktighet och felkod, men aldrig dokumenttext eller hemliga autentiseringsuppgifter.
Exempel: komprimera en PDF
curl -X POST "https://DIN-PDF-INSTANS/api/v1/misc/compress-pdf" \
-F "fileInput=@avtal.pdf;type=application/pdf" \
-F "optimizeLevel=1" \
--output avtal-komprimerat.pdfHeaders och kompatibilitet
Avtalsfrid-specifika automationsheaders använder prefixet X-Avtalsfrid-. Server och klient måste uppgraderas tillsammans om ett kontrakt ändras.
Robust felhantering
- Sätt timeout utifrån filstorlek och verktygets vikt.
- Återförsök endast nätverksfel och 5xx-svar; skicka inte om valideringsfel blint.
- Använd unika jobbmappar och atomisk flytt när resultatet är validerat.
- Behåll originalfilen och en hash så att resultatet kan spåras.
