WSDL SDK Reference Guide

1. Overview

Tascent provides several methods for communicating with InSight One.

  1. C# SDK – Windows 10
  2. C++ SDK – Cross-platform
    1. Windows 10 available
    2. Linux and Mac - future
  3. SOAP/WSDL SDK/messages – Cross-platform

This document describes #3 - WSDL/SOAP SDK support. 

The InSight One is a network appliance designed around open standards for web services, communicating through Ethernet using SOAP. 

Functions are detailed in the Web Services Descriptive language (WSDL) file called abm_IrisRecognition.wsdl.  This API reference guide details the functionality and usage of the functions included in the WSDL file.

InSight One WSDL

The InSight One system has an internal SOAP service. A host device sends SOAP requests to:

https://”<<InSightOneIPaddress>>”/axis2/services/AOptixBioService/handleABM 

The Factory Default IP address is 10.100.100.10.

 

2. Introduction to WSDL

Communication with the InSight One device occurs through its Ethernet interface, using a SOAP-over-https protocol. Similar to the way in which C, C++, Java, or similar functions are described in an Application Programming Interface (API), SOAP functions are described using the XML-based Web Services Description Language (WSDL).  Messages are defined in the file “abm_IrisRecogntion.wsdl” (ABM)

As it is XML, abm_IrisRecogntion.wsdl  can be viewed using any text editor. For more sophisticated interaction, it is best viewed through a software development environment (such as Eclipse or Microsoft Visual Studio) or by changing the file extension from .wsdl to .xml and opening it through a web browser.

While the WSDL is designed to be read automatically by software applications, it has also been commented to help developers understand the included functionality. Comments start with “<!--" and end with “-->”

 

3. SOAP Server

The InSight system has an internal SOAP service that enables communication as described in abm_IrisRecognition.wsdl. A client can communicate with it by sending SOAP requests to:

https://InSightIPAddress/axis2/services/AOptixBioService/handleABM

The default IP address is set to 10.100.100.10, and can be changed through the Appliance Manager.

Connect to Appliance Manager: https://10.100.100.10/AppManager (ignore certificate warnings)

 

HTTPS Configuration

A SOAP message is authenticated using the certificate associated with that system. It is not sufficient to authenticate only a Login message, for example. PKI certificates may either be uploaded to a device or exported from a device following the processes described in “Tascent InSight Appliance Manager User Guide.”

 

4. SOAP Messages

Login_RequestParams

Parameter

Data Type

Required

Description

Username

String

Required

 

passwordHash

String

Required

Passwords should not contain any encryption.  The HTTPS connection will convert the password to the appropriate SHA-1 hashed format before sending to InSightOneBIOService.

EnableNotify

Boolean

Optional

 

NotificationServerURL

String

Optional

NULL – The ability to associate a Notification Server URL with a user login request is not support in current release.

 

Login_ResponseParams

Parameter

Data Type

Required

Description

Status

String

Required

Status code that shows result of user login process.

StatusString

String

Required

Status string that shows results of user login process.

 

Logout_RequestParams

Parameter

Data Type

Required

Description

Username

String

Required

 

 

Logout_ResponseParams

Parameter

Data Type

Required

Description

Status

String

Required

Status code that shows result of user logout process.

0= successful logout

statusString

String

Optional

Status string that shows results of user logout process.

 

Capture_RequestParams

Parameter

Data Type

Required

Description

eyeSelector

Integer

Optional

 eyeSelector = -1 Low res face 1056x789 JPG

eyeSeletor = -2 High res face 4224x3156 JPG

eyeSelector = 256 Left eye 640x480 BMP & low res face 1440x1920 JPG

eyeSelector = 257 Right eye 640x480 BMP & high res face 1440x1920 JPG

eyeSelector = 258 Both eyes 640x480 BMP & high res face 1440x1920 JPG

eyeSelector = 0 Left eye 640x480 BMP & low res face 720x960 JPG

eyeSelector = 1 Right eye 640x480 BMP & low res face 720x960 JPG

eyeSelector = 2 Both eyes 640x480 BMP & low res face 720x960 JPG

statusString

String

Optional

 

 

Capture_ResponseParams

Parameter

Data Type

Required

Description

captureResponse

Ipc_capture_result_t

Optional

Outputs data capture by the InSight One including face image, iris image and iris template.

statusString

String

Optional

0 = Successful capture

1054 = Failed occlusion faction

statusString

String

Optional

Outputs the result of last capture attempt.  “statusString” can be parsed for capture time, eye captured, number of attempts, HD value, False Match probability.

metaTraceData

Binary Data

Optional

 

 

AbortOperation_RequestParams

Parameter

Data Type

Required

Description

hardResetFlag

Boolean

Optional

Default setting is “True.”

 

AbortOperation_ResponseParams         

Parameter

Data Type

Required

Description

Status

Int

Optional

Output 0 for successful abort operation.

statusString

String

Optional

Output results of the abort operation.

 

GetParams_RequestParams

Parameter

Data Type

Required

Description

getParamArray

Imager_param[0..100]

Optional

CentralManagement_GetImagerSN

CentralManagement_GetImagerMAC

CentralManagement_GetDeviceStatus

CentralManagement_GetImagerProductVersion

RecentFaceCaptured

RecentHRFrameCaptured

 

 

GetParams_ResponseParams 

Parameter

Data Type

Required

Description

getParamArray

Imager_param[0..100]

Optional

 

getParamArray

Imager_param[0..100]

Optional

 

statusString

String

Optional

Outputs the result of the operation. 

 

imager_param.name

Valid Fields in Response

Notes

“CentralManagement_GetImagerSN”

imager_param.svalue

Gets Serial Number

“CentralManagement_GetImagerMAC”

imager_param.svalue

Gets MAC Address

“CentralManagement_GetImagerProductProfile”

imager_param.svalue

Gets Product Profile

“CentralManagement_GetImageProductVersion”

imager_param.svalue

Gets SW version

“CentralManagement_GetDeviceStatus”

imager_param.svalue

imager_param.ivalue

Report the InSight status. See Note at the end of the section for more details.

“RecentFaceCaptured”

imager_param.data

imager_param.svalue

During face streaming, gets streaming images from InSight. See Note at the end of section for more details.

“RecentHRFrameCaptured”

imager_param.data

imager_param.svalue

Captures a high resolution image. See Note at end of section for more details.

 

5. Summary of Request/Response Functions

Function

Parameters

Login_RequestParams

 

Login_ResponseParams

 

Logout_ReqestParams

 

Logout_ResponseParams

 

Capture_RequestParams

eyeSelector = -1 Low res face 1056x789 JPG

eyeSeletor = -2 High res face 4224x3156 JPG

eyeSelector = 256 Left eye 640x480 BMP & high res face 1440x1920 JPG

eyeSelector = 257 Right eye 640x480 BMP & high res face 1440x1920 JPG

eyeSelector = 258 Both eyes 640x480 BMP & high res face 1440x1920 JPG

eyeSelector = 0 Left eye 640x480 BMP & low res face 720x960 JPG

eyeSelector = 1 Right eye 640x480 BMP & low res face 720x960 JPG

eyeSelector = 2 Both eyes 640x480 BMP & low res face 720x960 JPG

Capture_ResponseParams

 

AbortOperation_PrequestParams

 

AbortOperation_ResponseParams

 

SetParams_RequestParams

 

SetParams_ResponseParams

 

GetParams_RequestParams

CentralManagement_GetImagerSN

CentralManagement_GetImagerMAC

CentralManagement_GetDeviceStatus

CentralManagement_GetImagerProductVersion

RecentFaceCaptured

RecentHRFrameCaptured

 

GetParams_ResponseParams

 

 

 

 

Was this article helpful?
0 out of 0 found this helpful