openalpr_api

OpenalprApi - JavaScript client for openalpr_api No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.1
• Package version: 2.0.1
• Build date: 2017-02-24T16:12:47.806-05:00
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install openalpr_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var OpenalprApi = require('openalpr_api');
 
var api = new OpenalprApi.DefaultApi()
 
var imageBytes = "imageBytes_example"; // {String} The image file that you wish to analyze encoded in base64 
 
var secretKey = "secretKey_example"; // {String} The secret key used to authenticate your account.  You can view your  secret key by visiting  https://cloud.openalpr.com/ 
 
var 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 
 
var opts = { 
  'recognizeVehicle': 0, // {Integer} 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. 
  'returnImage': 0, // {Integer} If set to 1, the image you uploaded will be encoded in base64 and  sent back along with the response 
  'topn': 10, // {Integer} 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 
};
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.recognizeBytes(imageBytes, secretKey, country, opts, callback);
 

Documentation for API Endpoints

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

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

Documentation for Models

• OpenalprApi.Coordinate
• OpenalprApi.InlineResponse200
• OpenalprApi.InlineResponse200ProcessingTime
• OpenalprApi.InlineResponse400
• OpenalprApi.PlateCandidate
• OpenalprApi.PlateDetails
• OpenalprApi.RegionOfInterest
• OpenalprApi.VehicleCandidate
• OpenalprApi.VehicleDetails

Documentation for Authorization

All endpoints do not require authorization.