README

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.0.1
Build date: 2017-02-24T16:12:48.827-05:00
Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAlprApi/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$image_bytes = "image_bytes_example"; // string | The image file that you wish to analyze encoded in base64
$secret_key = "secret_key_example"; // string | The secret key used to authenticate your account.  You can view your  secret key by visiting  https://cloud.openalpr.com/
$country = "country_example"; // string | Defines the training data used by OpenALPR.  \"us\" analyzes  North-American style plates.  \"eu\" analyzes European-style plates.  This field is required if using the \"plate\" task  You may use multiple datasets by using commas between the country  codes.  For example, 'au,auwide' would analyze using both the  Australian plate styles.  A full list of supported country codes  can be found here https://github.com/openalpr/openalpr/tree/master/runtime_data/config
$recognize_vehicle = 0; // int | If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request
$state = ""; // string | Corresponds to a US state or EU country code used by OpenALPR pattern  recognition.  For example, using \"md\" matches US plates against the  Maryland plate patterns.  Using \"fr\" matches European plates against  the French plate patterns.
$return_image = 0; // int | If set to 1, the image you uploaded will be encoded in base64 and  sent back along with the response
$topn = 10; // int | The number of results you would like to be returned for plate  candidates and vehicle classifications
$prewarp = ""; // string | Prewarp configuration is used to calibrate the analyses for the  angle of a particular camera.  More information is available here http://doc.openalpr.com/accuracy_improvements.html#calibration

try {
    $result = $api_instance->recognizeBytes($image_bytes, $secret_key, $country, $recognize_vehicle, $state, $return_image, $topn, $prewarp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recognizeBytes: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.openalpr.com/v2

Class	Method	HTTP request
DefaultApi	recognizeBytes	POST /recognize_bytes
DefaultApi	recognizeFile	POST /recognize
DefaultApi	recognizeUrl	POST /recognize_url

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

arsengoian / openalpr

Maintainers

Details