intuate/idmanager ¶

idManager - JavaScript client for intuate/idmanager Documentation api for developers This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.40.0
Package version: 0.40.0
Build package: org.openapitools.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:

1	`npm install @intuate/idmanager --save`

Finally, you need to build the module:

1	`npm run build`

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:

1	`npm install`

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

1	`npm link`

To use the link you just defined in your project, switch to the directory you want to use your intuate/idmanager from, and run:

1	`npm link /path/to/<JAVASCRIPT_CLIENT_DIR>`

Finally, you need to build the module:

1	`npm run build`

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:

1	`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):

1	`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('@intuate/idmanager');


var api = new idManager.ClientsApi()
var uuid = "uuid_example"; // {String} uuid is the device identifier
api.deleteEnroll(uuid).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints¶

All URIs are relative to /api

Class	Method	HTTP request	Description
idManager.ClientsApi	deleteEnroll	DELETE /v1/clients/{uuid}/enroll	Cancel enroll
idManager.ClientsApi	deleteTemplate	DELETE /v1/clients/{uuid}/template	Cancel template
idManager.ClientsApi	getEnroll	GET /v1/clients/{uuid}/enroll	Enroll template from image
idManager.ClientsApi	getEnrollStatus	GET /v1/clients/{uuid}/enroll_status	Status of enrollment
idManager.ClientsApi	getTemplate	GET /v1/clients/{uuid}/template	Template, image and quality
idManager.CovidApi	covidDecodeImage	POST /v1/covid/image	Decode covid image QR
idManager.CovidApi	covidDecodePdf	POST /v1/covid/pdf	Decode covid pdf
idManager.CovidApi	covidDecodeQR	POST /v1/covid/qr	Decode covid QR
idManager.CredentialsApi	extractImage	POST /v1/credentials/fingerprint/extractImage	Extract image
idManager.CredentialsApi	identify	POST /v1/credentials/fingerprint/identify	Fingerprint identification
idManager.CredentialsApi	identifyCredentials	POST /v1/credentials/identify	Credentials 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	getCard	GET /v1/devices/card	Capture Card
idManager.DevicesApi	getCardBin	GET /v1/devices/cardbin	Capture Card
idManager.DevicesApi	getCardStatus	GET /v1/devices/cardstate	Capture Card
idManager.DevicesApi	getDescriptions	GET /v1/devices/{uuid}/descriptions	Device descriptions
idManager.DevicesApi	getDevices	GET /v1/devices	List of devices uuid
idManager.DevicesApi	getOCR	GET /v1/devices/ocr	Capture OCR
idManager.DevicesApi	getState	GET /v1/devices/{uuid}/state	Device state
idManager.FingerprintsApi	clearFingerprints	DELETE /v1/identifications/{code}/fingerprints	Clear fingerprints
idManager.FingerprintsApi	createFingerprint	POST /v1/identifications/{code}/fingerprints	Create a fingerprint
idManager.FingerprintsApi	deleteFingerprint	DELETE /v1/identifications/{code}/fingerprints/{index}	Delete a fingerprint
idManager.FingerprintsApi	deleteFingerprintsFinger	DELETE /v1/identifications/{code}/fingerprints/finger/{finger}	Delete fingerprints finger
idManager.FingerprintsApi	getFingerprint	GET /v1/identifications/{code}/fingerprints/{index}	Gets a fingerprint
idManager.FingerprintsApi	listFingerprints	GET /v1/identifications/{code}/fingerprints	List fingerprints
idManager.FingerprintsApi	updateFingerprint	PUT /v1/identifications/{code}/fingerprints/{index}	Update a fingerprint
idManager.IdentificationsApi	batchCreateIdentifications	POST /v1/identifications	Batch create several identifications
idManager.IdentificationsApi	createIdentification	POST /v1/identifications/{code}	Creates an identification
idManager.IdentificationsApi	deleteIdentification	DELETE /v1/identifications/{code}	Deletes an identification
idManager.IdentificationsApi	getIdentification	GET /v1/identifications/{code}	Gets an identification
idManager.IdentificationsApi	getIdentificationSummaryCredentialCodes	GET /v1/identifications/summary/code	GetIdentificationSummaryCredentialCodes get a summary of all credentials by code // TODO: Report
idManager.IdentificationsApi	getIdentificationSummaryCredentials	GET /v1/identifications/summary/all	GetIdentificationSummaryCredentials get a summary of all credentials // TODO: Report
idManager.IdentificationsApi	listIdentifications	GET /v1/identifications	Lists identifications
idManager.ImagesApi	convertImage	POST /v1/images/convert	Converts an image to another image
idManager.ImagesApi	saveImage	POST /v1/images/save	Saves an image
idManager.PasswordsApi	clearPasswords	DELETE /v1/identifications/{code}/passwords	Clear passwords
idManager.PasswordsApi	createPassword	POST /v1/identifications/{code}/passwords	Create a password
idManager.PasswordsApi	deletePassword	DELETE /v1/identifications/{code}/passwords/{index}	Delete a password
idManager.PasswordsApi	getPassword	GET /v1/identifications/{code}/passwords/{index}	Gets a password
idManager.PasswordsApi	listPasswords	GET /v1/identifications/{code}/passwords	List passwords
idManager.PasswordsApi	updatePassword	PUT /v1/identifications/{code}/passwords/{index}	Update a password
idManager.PushApi	access	POST /v1/push/access	Access
idManager.PushApi	action	POST /v1/push/action	Action
idManager.PushApi	status	POST /v1/push/status	Status
idManager.StatusApi	listEndpoints	GET /v1/status/endpoints	List endpoints
idManager.StatusApi	ping	GET /v1/status/ping	Ping server
idManager.StatusApi	version	GET /v1/status/version	Version information
idManager.TagsApi	clearTagsByCode	DELETE /v1/tags/code/{code}	Clear tags by identification code
idManager.TagsApi	createTag	POST /v1/tags	Create a tag
idManager.TagsApi	deleteTag	DELETE /v1/tags/{id}	Delete a tag
idManager.TagsApi	getTag	GET /v1/tags/{id}	Gets a tag
idManager.TagsApi	listTags	GET /v1/tags	List tags
idManager.TagsApi	updateTag	PUT /v1/tags/{id}	Update a tag
idManager.TerminalsApi	capture	POST /v1/terminals/capture/get	Capture fingerprint
idManager.TerminalsApi	captureCard	POST /v1/terminals/capturecard/get	Capture Card
idManager.TerminalsApi	captureIdCard	POST /v1/terminals/captureidcard/get	Capture ID Card
idManager.TerminalsApi	deleteLogs	POST /v1/terminals/logs/delete	Delete logs
idManager.TerminalsApi	deleteUsers	POST /v1/terminals/users/delete	Delete users in terminal
idManager.TerminalsApi	getLogs	POST /v1/terminals/logs/get	Get logs
idManager.TerminalsApi	getTime	POST /v1/terminals/time/get	Set time in terminal
idManager.TerminalsApi	getWorkcodes	POST /v1/terminals/workcodes/get	Get workcodes from terminal
idManager.TerminalsApi	isAlive	POST /v1/terminals/isalive/get	Check terminal connection
idManager.TerminalsApi	setTime	POST /v1/terminals/time/set	Set time in terminal
idManager.TerminalsApi	setUser	POST /v1/terminals/user/set	Set a user in terminal
idManager.TerminalsApi	setUsers	POST /v1/terminals/users/set	Set users in terminal
idManager.TerminalsApi	setWorkcodes	POST /v1/terminals/workcodes/set	Set workcodes in terminal

Documentation for Models¶

Documentation for Authorization¶

All endpoints do not require authorization.

intuate/idmanager¶