Skip to content

mc2_id_manager

Mc2IdManager - JavaScript client for mc2_id_manager MC² - idManager documentation api for testing This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: 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 mc2_id_manager --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your mc2_id_manager from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('mc2_id_manager') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var Mc2IdManager = require('mc2_id_manager');

var api = new Mc2IdManager.BiometricsApi()

var body = new Mc2IdManager.BiometricsExtractImageRequest(); // {BiometricsExtractImageRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.extractImage(body, callback);

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:46841/api

Class Method HTTP request Description
Mc2IdManager.BiometricsApi extractImage POST /v1/biometrics/fingerprint/extractImage Extract image
Mc2IdManager.BiometricsApi identify POST /v1/biometrics/fingerprint/identify Fingerprint identification
Mc2IdManager.BiometricsApi identifyImage POST /v1/biometrics/fingerprint/identifyImage Fingerprint image identification
Mc2IdManager.DevicesApi deleteCapture DELETE /v1/devices/capture Cancel capture
Mc2IdManager.DevicesApi getCapabilities GET /v1/devices/capabilities Device capabilities
Mc2IdManager.DevicesApi getCapture GET /v1/devices/capture Capture image
Mc2IdManager.DevicesApi getCount GET /v1/devices/count Count readers
Mc2IdManager.DevicesApi getDescriptions GET /v1/devices/descriptions Device descriptions
Mc2IdManager.FingerprintsApi createFingerprint POST /v1/db/identifications/{code}/fingerprints Create a new fingerprint
Mc2IdManager.FingerprintsApi deleteFingerprint DELETE /v1/db/identifications/{code}/fingerprints/{index} Delete a fingerprint
Mc2IdManager.FingerprintsApi deleteFingerprints DELETE /v1/db/identifications/{code}/fingerprints Delete fingerprints
Mc2IdManager.FingerprintsApi getFingerprint GET /v1/db/identifications/{code}/fingerprints/{index} Get a fingerprint
Mc2IdManager.FingerprintsApi getFingerprints GET /v1/db/identifications/{code}/fingerprints Get fingerprint list
Mc2IdManager.FingerprintsApi updateFingerprint PUT /v1/db/identifications/{code}/fingerprints/{index} Update a fingerprint
Mc2IdManager.IdentificationsApi deleteIdentification DELETE /v1/db/identifications/{code} Delete an identification
Mc2IdManager.IdentificationsApi getIdentification GET /v1/db/identifications/{code} Get an identification
Mc2IdManager.IdentificationsApi getIdentifications GET /v1/db/identifications Get identification list
Mc2IdManager.ImagesApi convertImage2Image POST /v1/images/convert Convert an image to another image
Mc2IdManager.ImagesApi convertImage2RAW POST /v1/images/raw Convert an image to RAW
Mc2IdManager.ImagesApi saveImage2File POST /v1/images/file Save an image in server
Mc2IdManager.StatusApi getEndpoints GET /v1/endpoints Get all endpoints
Mc2IdManager.StatusApi getVersion GET /v1/version Get version information
Mc2IdManager.StatusApi ping GET /v1/ping Ping service

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.