idmanager¶

idManager - JavaScript client for idmanager documentation api for developers. 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 idmanager --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 idmanager from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('idmanager') 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 idManager = require('idmanager');

var api = new idManager.CredentialsApi()

var body = new idManager.ModelImage(); // {ModelImage} image details to extract


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
idManager.CredentialsApi	extractImage	POST /v1/credentials/fingerprint/extractImage	Extract image
idManager.CredentialsApi	identify	POST /v1/credentials/fingerprint/identify	Fingerprint identification
idManager.CredentialsApi	identifyImage	POST /v1/credentials/fingerprint/identifyImage	Fingerprint image identification
idManager.CredentialsApi	imageQuality	POST /v1/credentials/fingerprint/imageQuality	Fingerprint image quality score
idManager.CredentialsApi	passwordCheckCode	POST /v1/credentials/password/check	Check password
idManager.DevicesApi	deleteCapture	DELETE /v1/devices/{uuid}/capture	Cancel capture
idManager.DevicesApi	getCapabilities	GET /v1/devices/{uuid}/capabilities	Device capabilities
idManager.DevicesApi	getCapture	GET /v1/devices/{uuid}/capture	Capture image
idManager.DevicesApi	getDescriptions	GET /v1/devices/{uuid}/descriptions	Device descriptions
idManager.DevicesApi	getDevices	GET /v1/devices	List of devices uuid
idManager.DevicesApi	getStatus	GET /v1/devices/{uuid}/status	Device status
idManager.FingerprintsApi	createFingerprint	POST /v1/identifications/{code}/fingerprints	Create a new fingerprint
idManager.FingerprintsApi	deleteFingerprint	DELETE /v1/identifications/{code}/fingerprints/{index}	Delete a fingerprint
idManager.FingerprintsApi	deleteFingerprints	DELETE /v1/identifications/{code}/fingerprints	Delete fingerprints
idManager.FingerprintsApi	getFingerprint	GET /v1/identifications/{code}/fingerprints/{index}	Get a fingerprint
idManager.FingerprintsApi	getFingerprints	GET /v1/identifications/{code}/fingerprints	Get fingerprint list
idManager.FingerprintsApi	updateFingerprint	PUT /v1/identifications/{code}/fingerprints/{index}	Update a fingerprint
idManager.IdentificationsApi	deleteIdentification	DELETE /v1/identifications/{code}	Delete an identification
idManager.IdentificationsApi	getIdentification	GET /v1/identifications/{code}	Get an identification
idManager.IdentificationsApi	getIdentifications	GET /v1/identifications	Get identification list
idManager.ImagesApi	convertImage2Image	POST /v1/images/convert	Convert an image to another image
idManager.ImagesApi	convertImage2RAW	POST /v1/images/raw	Convert an image to RAW
idManager.ImagesApi	saveImage2File	POST /v1/images/file	Save an image in server
idManager.PasswordsApi	createPassword	POST /v1/identifications/{code}/passwords	Create a new password
idManager.PasswordsApi	deletePassword	DELETE /v1/identifications/{code}/passwords/{index}	Delete a password
idManager.PasswordsApi	deletePasswords	DELETE /v1/identifications/{code}/passwords	Delete passwords
idManager.PasswordsApi	getPassword	GET /v1/identifications/{code}/passwords/{index}	Get a password
idManager.PasswordsApi	getPasswords	GET /v1/identifications/{code}/passwords	Get password list
idManager.PasswordsApi	updatePassword	PUT /v1/identifications/{code}/passwords/{index}	Update a password
idManager.StatusApi	getEndpoints	GET /v1/status/endpoints	Get all endpoints
idManager.StatusApi	getVersion	GET /v1/status/version	Get version information
idManager.StatusApi	ping	GET /v1/status/ping	Ping service
idManager.TagsApi	createTag	POST /v1/identifications/{code}/tags	Create a new tag
idManager.TagsApi	deleteTag	DELETE /v1/identifications/{code}/tags/{index}	Delete a tag
idManager.TagsApi	deleteTags	DELETE /v1/identifications/{code}/tags	Delete tags
idManager.TagsApi	getTag	GET /v1/identifications/{code}/tags/{index}	Get a tag
idManager.TagsApi	getTags	GET /v1/identifications/{code}/tags	Get tag list
idManager.TagsApi	updateTag	PUT /v1/identifications/{code}/tags/{index}	Update a tag
idManager.TerminalsApi	capture	POST /v1/terminals/capture	Capture fingerprint
idManager.TerminalsApi	getLogs	POST /v1/terminals/log	GetLogs fingerprint
idManager.TerminalsApi	isAlive	POST /v1/terminals/isalive	IsAlive check terminal
idManager.TerminalsApi	setTime	POST /v1/terminals/time	SetTime fingerprint
idManager.TerminalsApi	setUser	POST /v1/terminals/user	SetUser fingerprint
idManager.TerminalsApi	setUsers	POST /v1/terminals/users	SetUsers fingerprint
idManager.TerminalsApi	setWorkcodes	POST /v1/terminals/workcode	SetWorkcodes fingerprint

Documentation for Models¶

Documentation for Authorization¶

All endpoints do not require authorization.