https://github.com/mindee/mindee-api-java
Mindee API Helper Library for Java
https://github.com/mindee/mindee-api-java
api-client java-11 java-8 ocr ocr-api
Last synced: 9 months ago
JSON representation
Mindee API Helper Library for Java
- Host: GitHub
- URL: https://github.com/mindee/mindee-api-java
- Owner: mindee
- License: mit
- Created: 2022-02-14T14:06:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T09:51:19.000Z (9 months ago)
- Last Synced: 2025-04-08T10:35:45.546Z (9 months ago)
- Topics: api-client, java-11, java-8, ocr, ocr-api
- Language: Java
- Homepage: https://mindee.com
- Size: 14.7 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT) [](https://github.com/mindee/mindee-api-java) [](https://mvnrepository.com/artifact/com.mindee.sdk/mindee-api-java)
# Mindee Client Library for Java
Quickly and easily connect to Mindee's API services using Java.
## Quick Start
Here's the TL;DR of getting started.
First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
Include the following maven dependency in your project to use the helper library:
```xml
mindee-api-java
com.mindee.sdk
${mindee.sdk.version}
```
Where `${mindee.sdk.version}` is the version shown here:
## Loading a File and Parsing It
The `MindeeClient` class is the entry point for most of the helper library features.
## Synchronously Parsing a File
This is the easiest and fastest way to integrate into the Mindee API.
However, not all products are available in synchronous mode.
### Global Documents
These classes are available in the `com.mindee.product` package:
```java
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.product.invoice.InvoiceV4;
import java.io.File;
import java.io.IOException;
public class SimpleMindeeClient {
public static void main(String[] args) throws IOException {
// Init a new client
MindeeClient mindeeClient = new MindeeClient("my-api-key");
// Load a file from disk
LocalInputSource localInputSource = new LocalInputSource(
"/path/to/the/file.ext"
);
// Parse the file
Document response = mindeeClient.parse(
InvoiceV4.class,
localInputSource
);
// Print a summary of the parsed data
System.out.println(response.getDocument().toString());
}
}
```
**Note for Region-Specific Documents:**
Each region will have its own package within the general `com.mindee.product` package.
For example USA-specific classes will be in the `com.mindee.product.us` package:
```java
import com.mindee.product.us.bankcheck.BankCheckV1;
```
### Custom Documents (docTI & Custom APIs)
```java
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.product.generated.GeneratedV1;
import com.mindee.http.Endpoint;
import java.io.File;
import java.io.IOException;
public class SimpleMindeeClient {
public static void main(String[] args) throws IOException {
// Init a new client
MindeeClient mindeeClient = new MindeeClient("my-api-key");
// Init the endpoint for the custom document
Endpoint endpoint = new Endpoint("my-endpoint", "my-account");
// Load a file from disk
LocalInputSource localInputSource = new LocalInputSource(
"src/main/resources/invoices/invoice1.pdf"
);
// Parse the file
Document customDocument = mindeeClient.enqueueAndParse(
localInputSource,
endpoint
);
}
}
```
## Asynchronously Parsing a File
This allows for easier handling of bursts of documents sent.
Some products are only available asynchronously, check the example code
directly on the Mindee platform.
### Enqueue and Parse a File
The client library will take care of handling the polling requests for you.
This is the easiest way to get started.
```java
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.AsyncPredictResponse;
import com.mindee.product.internationalid.InternationalIdV2;
import java.io.File;
import java.io.IOException;
public class SimpleMindeeClient {
public static void main(String[] args) throws IOException, InterruptedException {
String apiKey = "my-api-key";
String filePath = "/path/to/the/file.ext";
// Init a new client
MindeeClient mindeeClient = new MindeeClient(apiKey);
// Load a file from disk
LocalInputSource inputSource = new LocalInputSource(new File(filePath));
// Parse the file asynchronously
AsyncPredictResponse response = mindeeClient.enqueueAndParse(
InternationalIdV2.class,
inputSource
);
// Print a summary of the response
System.out.println(response.toString());
}
}
```
### Enqueue and Parse a Webhook Response
This is an optional way of handling asynchronous APIs.
```java
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.input.LocalResponse;
import com.mindee.input.WebhookSource;
import com.mindee.product.internationalid.InternationalIdV2;
import java.io.IOException;
public class SimpleMindeeClient {
public static void main(String[] args) throws IOException {
// Init a new client
MindeeClient mindeeClient = new MindeeClient("my-api-key");
// Load a file from disk
LocalInputSource localInputSource = new LocalInputSource(
"/path/to/the/file.ext"
);
// Enqueue the file
String jobId = client.enqueue(InternationalIdV2.class, localInputSource)
.getJob().getId();
// Load the JSON string sent by the Mindee webhook POST callback.
//
// Reading the callback data will vary greatly depending on your HTTP server.
// This is therefore beyond the scope of this example.
String jsonData = myHttpServer.getPostBodyAsString();
LocalResponse localResponse = new LocalResponse(jsonData);
// Verify the HMAC signature.
// You'll need to get the "X-Mindee-Hmac-Signature" custom HTTP header.
String hmacSignature = myHttpServer.getHeader("X-Mindee-Hmac-Signature");
boolean isValid = localResponse.isValidHmacSignature(
"obviously-fake-secret-key", hmacSignature
);
if (!isValid) {
throw new MyException("Bad HMAC signature! Is someone trying to do evil?");
}
// You can also use a File object as the input.
//LocalResponse localResponse = new LocalResponse(new File("/path/to/file.json"));
// Deserialize the response into Java objects
AsyncPredictResponse response = mindeeClient.loadPrediction(
InternationalIdV2.class,
localResponse
);
// Print a summary of the parsed data
System.out.println(response.getDocument().toString());
}
}
```
## Further Reading
Complete details on the working of the library are available in the following guides:
* [Getting started](https://developers.mindee.com/docs/java-ocr-getting-started)
* [Java Generated APIs](https://developers.mindee.com/docs/java-generated-ocr)
* [Java Custom APIs (API Builder - Deprecated)](https://developers.mindee.com/docs/java-api-builder)
* [Java Invoice OCR](https://developers.mindee.com/docs/java-invoice-ocr)
* [Java Receipt OCR](https://developers.mindee.com/docs/java-receipt-ocr)
* [Java Financial Document OCR](https://developers.mindee.com/docs/java-financial-document-ocr)
* [Java Passport OCR](https://developers.mindee.com/docs/java-passport-ocr)
* [Java Resume OCR](https://developers.mindee.com/docs/java-resume-ocr)
* [Java International Id OCR](https://developers.mindee.com/docs/java-international-id-ocr)
* [Java FR Bank Account Detail OCR](https://developers.mindee.com/docs/java-fr-bank-account-details-ocr)
* [Java FR Carte Grise OCR](https://developers.mindee.com/docs/java-fr-carte-grise-ocr)
* [Java FR Health Card OCR](https://developers.mindee.com/docs/java-fr-health-card-ocr)
* [Java FR ID Card OCR](https://developers.mindee.com/docs/java-fr-carte-nationale-didentite-ocr)
* [Java US Bank Check OCR](https://developers.mindee.com/docs/java-us-bank-check-ocr)
* [Java Barcode Reader API](https://developers.mindee.com/docs/java-barcode-reader-ocr)
* [Java Cropper API](https://developers.mindee.com/docs/java-cropper-ocr)
* [Java Invoice Splitter API](https://developers.mindee.com/docs/java-invoice-splitter-ocr)
* [Java Multi Receipts Detector API](https://developers.mindee.com/docs/java-multi-receipts-detector-ocr)
You can view the source code on [GitHub](https://github.com/mindee/mindee-api-java).
You can also take a look at the
**[Reference Documentation](https://mindee.github.io/mindee-api-java/)**.
## License
Copyright © Mindee
Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Questions?
[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)