User registration and integration
#
OverviewThis document describes how to implement user registration and integration with the iOS SDK.
#
Feature DescriptioniOS SDK provides features to register and integrate user into GCCS system by using the basic information.
#
User Information Uniqueness CheckPrevious to GCCS registration, each user must have unique and original information and does not contain duplicate value.
Check uniqueness by using isDuplicatedEmailOrPhoneNumber()
to call the API from GuardianSdk
.
Whether user information is unique or not can be identified upon the verifyType
.
#
ParameterKey | Value | Description |
---|---|---|
verifyType | String | - CMMDUP001 : Email - CMMDUP002 : SMS |
verifyData | String | Depends on the verifyType - If verifyType is CMMDUP001, verifyData is email - If verifyType is CMMDUP002, verifyData is phone number |
#
Example// Checking user information uniquenessGuardianAPI().isDuplicatedEmailOrPhoneNumber(verifyType: "CMMDUP001",verifyData: email) { data in GuardianAPI().isDuplicatedEmailOrPhoneNumber(verifyType: "CMMDUP002",verifyData: fullNumber){data in ... } }
#
RegisterClientUserResponseKey | Value | Description |
---|---|---|
rtCode | 0 | Result code |
rtMsg | String | Result message |
When the API call to check registered information uniqueness is successful and there is no duplicate value, the rtCode
will be 0
and if not, the rtCode
will be 2019
.
#
ErrorResultKey | Value | Description |
---|---|---|
errorCode | 0 | Error code |
If API call fails, the user will receive an errorCode
.
#
GCCS RegistrationUse requestMemberRegister()
from GuardianSdk
to call the API that can handle GCCS registration request.
#
ParameterKey | Value | Description |
---|---|---|
userKey | String | User ID/Key |
name | String | Name |
phoneNum | String | Phone number |
String |
The value must be in Dictionary<KeyType, ValueType>
type.
#
Example// GCCS registration GuardianService.sharedInstance.requestMemberRegister(memberObject: self.params) { rtCode, rtMsg, data in ... } onFailed: { err, errMsg in ... }
#
RegisterClientUserResponseKey | Value | Description |
---|---|---|
rtCode | 0 | Result code |
rtMsg | String | Result message |
When the API call for biometric authentication is successful, the rtCode
will be 0
The user registration and integration is complete then.
#
ErrorResultKey | Value | Description |
---|---|---|
errorCode | 0 | Error code |
If API call fails, the user will receive an errorCode