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
Name | Type | Description |
---|---|---|
page | Int | Page number |
size | Int | Size per page |
Response
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
{page} | class | |
page.first | boolean | Check if the current data is on the first page. |
page.last | boolean | Check if the current data is on the last page. |
page.currentPage | Int | Current page number. |
page.pageSize | Int | Number of data entries per page. |
page.totalElements | Int | Total number of data entries. |
page.totalPages | Int | Total number of pages calculated based on (pageSize). |
{data} | class | |
data.seq | Int | Serial number |
data.clientKey | String | Unique client key |
data.clientName | String | Client name |
data.status | String | status code |
data.platform | String | connected OS Informaion |
data.regDt | String | Registration 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
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
{data} | class | |
data.seq | Int | Serial number |
data.clientKey | String | Unique client key |
data.clientName | String | Client name |
data.userStatus | String | User status code |
data.clientExplain | String | Client description |
data.siteUrl | String | Site URL |
data.interlock | Boolean | Connection status |
data.verifyType | String | Verification 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
Name | Type | Description |
---|---|---|
clientName | String | Client name |
Response
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
{data} | class | |
data.seq | Int | Serial number |
data.clientKey | String | Unique client key |
data.clientName | String | Client name |
data.userStatus | String | User status code |
data.clientExplain | String | Client description |
data.siteUrl | String | Site URL |
data.interlock | Boolean | Connection status |
data.verifyType | String | Verification 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
Name | Type | Description |
---|---|---|
clientKey | String | Unique client key |
id | String | ID registered on the client site |
pw | String | Password of the account registered on the client site |
Response
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
token | String | Verification 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
Name | Type | Description |
---|---|---|
clientKey | String | Unique client key |
siteToken | String | Token received after site verification |
Response
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
data | Boolean | Link 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
Name | Type | Description |
---|---|---|
clientKey | String | Unique client key |
Response
Name | Type | Description |
---|---|---|
rtCode | Int | Result code |
rtMsg | String | Result message |
data | Boolean | Link result |