Skip to content

docs: use explicit regional target in README examples #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rferreira merged 1 commit into from
May 5, 2026
Merged

docs: use explicit regional target in README examples #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ Official Java SDK for the [Scanii](https://www.scanii.com) content processing AP
```java
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("your-api-key", "your-api-secret");
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());
```
Expand Down Expand Up @@ -57,13 +58,13 @@ See the [API spec](https://scanii.github.io/openapi/v22/) for full details.

| Constant | Endpoint |
|---|---|
| `ScaniiTarget.AUTO` | `https://api.scanii.com` |
| `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

Expand Down
Loading