scanii-java

Official Java SDK for the Scanii content processing API.

SDK Principles

1. Light. Zero runtime dependencies, stdlib only.
2. Up to date. Always current with the latest Scanii API.
3. Integration-only. Wraps the REST API — retries, concurrency, and batching are the caller's responsibility.

Install

<dependency>
  <groupId>com.scanii</groupId>
  <artifactId>scanii-java</artifactId>
  <version>8.2.0</version>
</dependency>

Quickstart

import com.scanii.ScaniiClient;
import com.scanii.ScaniiClients;
import com.scanii.ScaniiTarget;
import com.scanii.models.ScaniiProcessingResult;
import java.nio.file.Paths;

ScaniiClient client = ScaniiClients.createDefault(ScaniiTarget.US1, "your-api-key", "your-api-secret");
ScaniiProcessingResult result = client.process(Paths.get("/path/to/file"));
System.out.printf("findings: %s%n", result.getFindings());

API reference

Method	Description
process(Path content)	Synchronous file scan
process(InputStream content)	Synchronous stream scan
process(Path content, Map<String,String> metadata)	Scan with metadata
process(Path content, String callback, Map<String,String> metadata)	Scan with callback
processAsync(Path content)	Async-on-server scan, returns pending result
processFromUrl(URI location)	Synchronous remote-URL scan
processFromUrl(URI location, Map<String,String> metadata)	Remote-URL scan with metadata
retrieve(String id)	Retrieve previous scan result
retrieveTrace(String id)	Retrieve ordered processing events for a result (preview)
fetch(String location)	Server-side async fetch-and-scan of a remote URL
ping()	Health check
createAuthToken(int timeout, TimeUnit unit)	Mint short-lived auth token
retrieveAuthToken(String id)	Inspect auth token
deleteAuthToken(String id)	Revoke auth token
retrieveAccountInfo()	Retrieve account information

See the API spec for full details.

Regional endpoints

Constant	Endpoint
ScaniiTarget.US1	https://api-us1.scanii.com
ScaniiTarget.EU1	https://api-eu1.scanii.com
ScaniiTarget.EU2	https://api-eu2.scanii.com
ScaniiTarget.AP1	https://api-ap1.scanii.com
ScaniiTarget.AP2	https://api-ap2.scanii.com
ScaniiTarget.CA1	https://api-ca1.scanii.com
ScaniiTarget.AUTO	https://api.scanii.com — deprecated, does not guarantee regional data placement

Local development with scanii-cli

Run integration tests against a local mock server — no real credentials needed:

docker run -d --name scanii-cli -p 4000:4000 ghcr.io/scanii/scanii-cli:latest server
mvn verify

Test credentials: key key, secret secret, endpoint http://localhost:4000.

Migration from com.uvasoftware:scanii-java

Replace the Maven coordinates and rename imports:

com.uvasoftware.scanii  →  com.scanii

The old artifact com.uvasoftware:scanii-java is deprecated and will not receive further updates.

License

Apache 2.0 — see LICENSE.