Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mindee/mindee-api-php

Mindee API Helper Library for PHP
https://github.com/mindee/mindee-api-php

api-client composer php7

Last synced: about 6 hours ago
JSON representation

Mindee API Helper Library for PHP

Host: GitHub
URL: https://github.com/mindee/mindee-api-php
Owner: mindee
License: mit
Created: 2022-05-27T09:57:58.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-11-05T10:36:36.000Z (1 day ago)
Last Synced: 2024-11-05T11:26:14.344Z (1 day ago)
Topics: api-client, composer, php7
Language: PHP
Homepage:
Size: 1.61 MB
Stars: 4
Watchers: 2
Forks: 3
Open Issues: 1
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

        [![License: MIT](https://img.shields.io/github/license/mindee/mindee-api-php)](https://opensource.org/licenses/MIT) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mindee/mindee-api-php/unit-test.yml)](https://github.com/mindee/mindee-api-php) [![Packagist Version](https://img.shields.io/packagist/v/mindee/mindee)](https://packagist.org/packages/mindee/mindee) [![Downloads](https://img.shields.io/packagist/dm/mindee/mindee)](https://packagist.org/packages/mindee/mindee)

# Mindee API Helper Library for PHP

Quickly and easily connect to Mindee's API services using PHP.

## Quick Start

Here's the TL;DR of getting started.

First, get an [API Key](https://developers.mindee.com/docs/create-api-key)

If you do not have them, you'll need the following packages on your system:

* [php-curl](https://www.php.net/manual/en/curl.installation.php)

* [php-json](https://www.php.net/manual/en/json.installation.php) (not necessary for versions >= 8.0.0)

* [php-fileinfo](https://www.php.net/manual/en/fileinfo.installation.php)

Then, install this library:

```shell

composer require mindee/mindee

```

Finally, PHP away!

### Loading a File and Parsing It

#### Global Documents

```php

sourceFromPath("/path/to/the/file.ext");

// Parse the file

$apiResponse = $mindeeClient->parse(InvoiceV4::class, $inputSource);

// Print a brief summary of the parsed data

echo strval($apiResponse->document);

```

**Note:** Files can also be loaded from:

A PHP `File` compatible file:

```php

$inputDoc = $mindeeClient->sourceFromFile($myFile);

```

A URL (`HTTPS` only):

```php

$inputDoc = $mindeeClient->sourceFromUrl("https://files.readme.io/a74eaa5-c8e283b-sample_invoice.jpeg");

```

A base64-encoded string, making sure to specify the extension of the file name:

```php

$inputDoc = $mindeeClient->sourceFromB64($myInputString, "my-file-name.ext");

```

Raw bytes, making sure to specify the extension of the file name:

```php

$inputDoc = $mindeeClient->sourceFromBytes($myRawBytesSequence, "my-file-name.ext");

```

#### Region-Specific Documents

```php

use Mindee\Client;

use Mindee\Product\Us\BankCheck\BankCheckV1;

// Init a new client

$mindeeClient = new Client("my-api-key");

// Load a file from disk

$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file

$apiResponse = $mindeeClient->parse(BankCheckV1::class, $inputSource);

// Print a brief summary of the parsed data

echo strval($apiResponse->document);

```

#### Custom Document (API Builder)

```php

use Mindee\Client;

use Mindee\Product\Us\BankCheck\BankCheckV1;

// Init a new client

$mindeeClient = new Client("my-api-key");

// Load a file from disk

$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file

$apiResponse = $mindeeClient->parse(BankCheckV1::class, $inputSource);

// Print a brief summary of the parsed data

echo strval($apiResponse->document);

```

## Full PDF support

Some features such as Invoice Splitter auto-extraction & Multi Receipts auto-extraction require the [ImageMagick](https://www.php.net/manual/en/imagick.setup.php) library, which in turn requires [GhostScript](https://www.ghostscript.com/).

### Unix

ImageMagick is usually bundled with most installations. If not, you can install it using your distribution's package manager.

More details [here](https://imagemagick.org/script/advanced-linux-installation.php).

Ghostscript can be installed from the [website download page](https://ghostscript.com/releases/gsdnld.html), or if using an apt compatible distribution:

```bash

sudo apt-get update

sudo apt-get install -y ghostscript

```

In some cases, you might also want to authorize the ImageMagick policy to edit PDF files:

```bash

DQT='"'

SRC="rights=${DQT}none${DQT} pattern=${DQT}PDF${DQT}"

RPL="rights=${DQT}read|write${DQT} pattern=${DQT}PDF${DQT}"

sudo sed -i "s/$SRC/$RPL/" /etc/ImageMagick-6/policy.xml

```

### MacOS

Brew will be required for this install.

```bash

brew update

brew install imagemagick

pecl install imagick # Might not be needed in some instances. Do not try to install before installing PHP & Pecl.

```

### Windows

You can install [Ghostscript](https://ghostscript.com/releases/gsdnld.html) by downloading it, or simply by using [Chocolatey](https://chocolatey.org/).

```

choco install ghostscript --version 10.03.1 -y

```

**⚠️ Important note if you are using Windows** 

The `gs` alias might not be available by default, but it is possible to bind it fairly simply by either adding `gswin32c.exe` or `gswin64c.exe` to your `$PATH` and then adding a symlink in powershell using:

```

New-Item -ItemType SymbolicLink -Path "C:\Windows\gs.exe" -Target "C:\Program Files\gs\gs10.03.1\bin\gswin64c.exe"

New-Item -ItemType SymbolicLink -Path "C:\Windows\gs" -Target "C:\Program Files\gs\gs10.03.1\bin\gswin64c.exe"

```

## Further Reading

Complete details on the working of the library are available in the following guides:

* [Getting started](https://developers.mindee.com/docs/php-getting-started)

* [PHP Command Line Interface (CLI)](https://developers.mindee.com/docs/php-cli)

* [PHP Generated APIs](https://developers.mindee.com/docs/php-generated-api)

* [PHP Custom APIs (API Builder - Deprecated)](https://developers.mindee.com/docs/php-api-builder)

* [PHP Invoice OCR](https://developers.mindee.com/docs/php-invoice-ocr)

* [PHP Receipt OCR](https://developers.mindee.com/docs/php-receipt-ocr)

* [PHP Financial Document OCR](https://developers.mindee.com/docs/php-financial-document-ocr)

* [PHP Passport OCR](https://developers.mindee.com/docs/php-passport-ocr)

* [PHP Resume OCR](https://developers.mindee.com/docs/php-resume-ocr)

* [PHP Proof of Address OCR](https://developers.mindee.com/docs/php-proof-of-address-ocr)

* [PHP International Id OCR](https://developers.mindee.com/docs/php-international-id-ocr)

* [PHP EU License Plate OCR](https://developers.mindee.com/docs/php-eu-license-plate-ocr)

* [PHP EU Driver License OCR](https://developers.mindee.com/docs/php-eu-driver-license-ocr)

* [PHP FR Bank Account Detail OCR](https://developers.mindee.com/docs/php-fr-bank-account-details-ocr)

* [PHP FR Carte Grise OCR](https://developers.mindee.com/docs/php-fr-carte-grise-ocr)

* [PHP FR Carte Vitale OCR](https://developers.mindee.com/docs/php-fr-carte-vitale-ocr)

* [PHP FR ID Card OCR](https://developers.mindee.com/docs/php-fr-carte-nationale-didentite-ocr)

* [PHP US Bank Check OCR](https://developers.mindee.com/docs/php-us-bank-check-ocr)

* [PHP US W9 OCR](https://developers.mindee.com/docs/php-us-w9-ocr)

* [PHP US Driver License OCR](https://developers.mindee.com/docs/php-us-driver-license-ocr)

* [PHP Barcode Reader API](https://developers.mindee.com/docs/php-barcode-reader-ocr)

* [PHP Cropper API](https://developers.mindee.com/docs/php-cropper-ocr)

* [PHP Invoice Splitter API](https://developers.mindee.com/docs/php-invoice-splitter-ocr)

* [PHP Multi Receipts Detector API](https://developers.mindee.com/docs/php-multi-receipts-detector-ocr)

You can view the source code on [GitHub](https://github.com/mindee/mindee-api-php).

You can also take a look at the

**[Reference Documentation](https://mindee.github.io/mindee-api-php)**.

## 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)