| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 2_17 (other versions, change log, ZUMSTEIN_V4.1-SNAPSHOT) Deprecated. This version is frozen and still supported.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnco/external-remoting/com.secutix.service.contact.v2_17.ContactAuthenticationPublicService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnco/backend-apis/contactAuthenticationPublicService/v2_17/{methodName} Replace {methodName} for the desired method name as shown below.
To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.
For further documentation and examples, please check in Platform Website.
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method is used to authenticate a contact based on his login and password and more attributes available from ContactAuthenticationData.
Authentication can be based either on login+password, either on a anterior authentication having generated a unique identifier rememberMe.
During a login/password authentication, boolean remmemberMe allows to decide wether such a token must be generated. A rememberMe token is valid during one month max.
If authentication is done through a token, a NEW token + identifier are generated, invalidating the other ones.
This method takes into account parametrization of point of sales. In case of B2B sales, it checks wether the contact is authorized to log on the given point of sales.
| contactAuthenticationData | ContactAuthenticationData |
| ContactAuthenticationData | ||
| contactTypeScope | (INDIVIDUAL|STRUCTURE| ANY) | |
| guestLogin | boolean | |
| identification | String | |
| identityProvider | String | |
| login | String | |
| password | String | |
| pointOfSalesId | Long | |
| providerUserReference | String | |
| rememberMe | boolean | |
| socialLogin | boolean | |
| structureContactNumber | String (20) | |
| targetContactNumber | String (20) | |
| uniqueToken | String | |
| ContactAuthenticationResult | ||
| contactNumber | String (20) | |
| identification | String | |
| uniqueToken | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method allows to modify the current password of a contact identified by its contact number.
| contactNumber | String (20) | Mandatory number of the contact to alter its password; mandatory. |
| currentPassword | String | Mandatory current contact password; mandatory; |
| newPassword | String | Mandatory new password if the existing password match; mandatory. |
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method returns the list of point of sales authorized for given contact who needs to be authenticated.
| contactNumber | String (20) | - the contact number who needs to be authenticated. |
| ListAuthorizedPOSResult | ||
| pointOfSales | List of PosSummary | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PosSummary | ||
| pointOfSalesId | Long | |
| url | String (255) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method allows a contact identified by the given email address to request a new randomly generated password for authentication. The old password is automatically invalidated.
| String | Mandatory Mandatory, email of the contact | |
| contactNumber | String (20) | Mandatory Only mandatory and to be considered for relay contacts.(STX-5744) Since the email is not unique and this function can used for individual contact and structure contact, we add a new parameter contactNumber to help identify the right contact to modify. |
| contactTypeScope | (INDIVIDUAL|STRUCTURE| ANY) |
| PasswordRecoveryResult | ||
| String | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |