Skip to content

Other APIs (Need for Access Token)

The following APIs require a valid Access Token obtained through authentication to be invoked successfully.

i. Authentication History Query

Example

kotlin
BsaSdk.getInstance().sdkService.getAuthHistory(page, size, object: object: SdkResponseCallback<AuthHistoryResponse> {
	override fun onSuccess(response: AuthHistoryResponse?) {
		// Code to execute after querying
		...
	}

	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
})

Parameter

NameTypeDescription
pageIntPage number
sizeIntSize per page

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
{page}class
page.firstbooleanCheck if the current data is on the first page.
page.lastbooleanCheck if the current data is on the last page.
page.currentPageIntCurrent page number.
page.pageSizeIntNumber of data entries per page.
page.totalElementsIntTotal number of data entries.
page.totalPagesIntTotal number of pages calculated based on (pageSize).
{data}class
data.seqIntSerial number
data.clientKeyStringUnique client key
data.clientNameStringClient name
data.statusStringstatus code
data.platformStringconnected OS Informaion
data.regDtStringRegistration date

ii. Linked Site List Query

Through BsaSdk's getMyLinkSite(), you can request the API to query the list of linked sites.

Example

kotlin
BsaSdk.getInstance().sdkService.getMyLinkSite(object: SdkResponseCallback<SiteLinkInfoResponse> {
	override fun onSuccess(siteLinkInfo: SiteLinkInfoResponse?) {
		// Code to execute after querying
		...
	}
	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
})

Parameter

  • None

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
{data}class
data.seqIntSerial number
data.clientKeyStringUnique client key
data.clientNameStringClient name
data.userStatusStringUser status code
data.clientExplainStringClient description
data.siteUrlStringSite URL
data.interlockBooleanConnection status
data.verifyTypeStringVerification type

iii. Search Site List Query

Through BsaSdk's getSearchLinkSite(), you can request the API to search for the list of sites to link.

Example

kotlin
BsaSdk.getInstance().sdkService.getSearchLinkSite(clientName, object: SdkResponseCallback<SiteLinkInfoResponse> {
	override fun onSuccess(siteLinkInfo: SiteLinkInfoResponse?) {
		// Code to execute after successful search
		...
	}
	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
})

Parameter

NameTypeDescription
clientNameStringClient name

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
{data}class
data.seqIntSerial number
data.clientKeyStringUnique client key
data.clientNameStringClient name
data.userStatusStringUser status code
data.clientExplainStringClient description
data.siteUrlStringSite URL
data.interlockBooleanConnection status
data.verifyTypeStringVerification type

iv. Site Account Authentication

Through BsaSdk's verifyLinkSite(), you can verify the site account to link with the API.

Example

kotlin
BsaSdk.getInstance().sdkService.verifyLinkSite(clientKey, id, password, object: SdkResponseCallback<SiteLinkVerifyResponse> {
	override fun onSuccess(siteLinkInfo: SiteLinkVerifyResponse?) {
		// Code to execute after successful verification
		...
	}
	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
})

Parameter

NameTypeDescription
clientKeyStringUnique client key
idStringID registered on the client site
pwStringPassword of the account registered on the client site

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
tokenStringVerification token for site link

v. Site Linking Request

Through BsaSdk's linkSite(), you can link a site that uses BSA authentication with the API.

Example

kotlin
BsaSdk.getInstance().sdkService.linkSite(clientKey, siteToken, object: SdkResponseCallback<SiteLinkResponse> {
	override fun onSuccess(siteLinkInfo: SiteLinkResponse?) {
		// Code to execute after successful addition
		...
	}
	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
})

Parameter

NameTypeDescription
clientKeyStringUnique client key
siteTokenStringToken received after site verification

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
dataBooleanLink result

vi. Site Unlinking Request

Through BsaSdk's unlinkSite(), you can request the API to unlink the linked site.

Example

kotlin
BsaSdk.getInstance().sdkService.unlinkSite(clientKey, object: SdkResponseCallback<SiteLinkResponse> {
	override fun onSuccess(siteLinkInfo: SiteLinkResponse?) {
		// Code to execute after successful unlinking
		...
	}
	override fun onFailed(errorResult: ErrorResult?) {
		...
	}
});

Parameter

NameTypeDescription
clientKeyStringUnique client key

Response

NameTypeDescription
rtCodeIntResult code
rtMsgStringResult message
dataBooleanLink result