OAuthService
When the mini program requests access to specific scopes (resources or capabilities), IAPMiniProgram SDK calls the OAuthService SPI to request the Super App to generate authorization codes for the mini program.
getAuthCode
Method signature
Call the getAuthCode
method to request the Super App to generate authorization codes for the mini program.
func getAuthCode(
clientId: String,
scopes: Set<String>,
type: IAPWalletOAuthCodeFlowType = .standard,
extendedInfo: [String : String] = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletOAuthResult) -> Void
) -> Void
Request parameters
Field | Data type | Description | Required |
clientId | String | The unique ID that is assigned by Mini Program Platform to identify a mini program. | Yes |
scopes | Set<String> | The authorization scopes, which represent the resources or capabilities that are requested by the mini program. Valid values are:
Notes:
Notes:
| Yes |
type | IAPWalletOAuthCodeFlowType | The type of the mini program. Valid values are:
| Yes |
extendedInfo | Dictionary<String, String> | An extended attribute that is used to provide additional information if necessary. | No |
context | IAPWalletAPIContext | A context object, carries the mini program runtime metadata. | No |
callback | Callback (For details, see the following section) | The callback that is executed when request processing is completed. | Yes |
Callback
Field | Data type | Description | Required |
result | The result of the | Yes |
Response parameters
N/A
showAuthPage
Method signature
The Super App calls the showAuthPage
method to display an authorization dialog to the user when the requested scopes require the user's agreement before being granted to mini programs.
func showAuthPage(
clientId: String,
name: String,
logo: String,
scopes: Set<String>,
extendedInfo: [String: String]? = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletAuthPageConfirmResult) -> Void
) -> Void
Request parameters
Field | Data type | Description | Required |
clientId | String | The unique ID that is assigned by Mini Program Platform to identify a mini program. | Yes |
scopes | Set<String> | The authorization scopes, which represent the resources or capabilities that are requested by the mini program. | Yes |
name | String | Auth client name | Yes |
logo | String | Auth client logo | No |
extendedInfo | Dictionary<String, String> | An extended attribute that is used to provide additional information if necessary. | No |
context | IAPWalletAPIContext | A context object, carries the mini program runtime metadata. | No |
callback | Callback (For details, see the following section) | The callback that is executed when request processing is complete. | Yes |
Callback
Field | Data type | Description | Required |
result | The result of the | Yes |
Response parameters
N/A
getAuthorizedScopes
Method signature
The Super App calls this method to retrieve a list of scopes that are granted to the mini program.
func getAuthorizedScopes(
clientId: String,
extendedInfo: [String: String] = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletOAuthScopeQueryResult) -> Void
) -> Void
Request parameters
Field | Data type | Description | Required |
clientId | String | The unique ID that is assigned by Mini Program Platform to identify a mini program. | Yes |
extendedInfo | Dictionary<String, String> | An extended attribute that is used to provide additional information if necessary. | NO |
context | IAPWalletAPIContext | A context object, carries the mini program runtime metadata. | NO |
callback | Callback (For details, see the following section) | The callback that is executed when request processing is complete. | Yes |
Callback
Field | Data type | Description | Required |
scopeQueryResult | IAPWalletOAuthScopeQueryResult | The result of the | Yes |
Response parameters
N/A
Error codes
Error code | Error message | |
1000 | ERROR_CODE_UNKNOWN_ERROR | Unknown error |
1001 | ERROR_CODE_USER_CANCEL | The user cancels the operation. |
1002 | ERROR_CODE_APP_SERVICE_ERROR | The app service is wrong. |
1003 | ERROR_CODE_TIMEOUT | Timeout |
2001 | ERROR_CODE_AUTH_PENDING_AGREEMENT | Authorization is not finished or is pending. |
1005 | ERROR_CODE_SYSTEM_ERROR | System error |
Samples
The following samples show how to call the OAuthService SPI to generate authorization codes for the mini program:
- Create a class that implements the OAuthService interface.
- Implement the
getAuthCode
method to request the Super App to generate authorization codes for the mini program - Implement the
showAuthPage
method to show the user authorization dialog. - Implement the
getAuthorizedScopes
method to retrieve a list of the authorized scopes.
Swift
final class OAuthService: IAPWalletOAuthServiceSignature {
// MARK: getAuthCode
override func getAuthCode(
clientId: String, scopes: Set<String>,
type: IAPWalletOAuthCodeFlowType = .standard,
extendedInfo: [String : String] = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletOAuthResult) -> Void
) {
//The logic to be executed if the requested scopes require the user's consent
let oAuthSuccessful: Bool = xxx
if (oAuthSuccessful) { //The logic to be executed if OAuth is successful
let oAuthResult = IAPWalletOAuthResult(
authCode: "AUTH_CODE",
authErrorScopes: [:],
authSuccessScopes: []
)
callback(oAuthResult)
} else { //The logic to be executed if Oauth fails
let oAuthResult = IAPWalletOAuthResult()
oAuthResult.error = NSError(
domain: "OAuthError",
code: IAPWalletBaseServiceResult.ERROR_CODE_AUTH_PENDING_AGREEMENT,
userInfo: [NSLocalizedDescriptionKey: "OAuth Params invalid"]
)
callback(oAuthResult)
}
}
// MARK: getAuthorizedScopes
override func getAuthorizedScopes(
clientId: String,
extendedInfo: [String : String] = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletOAuthScopeQueryResult) -> Void
) {
//The logic to retrieve a list of the authorized scopes
let authorizedScopes = ["xxx"]
let oAuthResult = IAPWalletOAuthScopeQueryResult(authorizedScopes: authorizedScopes)
callback(oAuthResult)
}
// MARK: showAuthPage
override func showAuthPage(
clientId: String,
name: String,
logo: String,
scopes: Set<String>,
extendedInfo: [String : String]? = [:],
in context: IAPWalletAPIContext? = nil,
callback: @escaping (IAPWalletAuthPageConfirmResult) -> Void
) {
//Show user authorization dialog
let alertController = UIAlertController(
title: "xxx auth page",
message: "Do you allow this service to get your auth code?",
preferredStyle: .alert
)
let cancelAction = UIAlertAction(title: "NO", style: .cancel) { _ in
let oAuthResult = IAPWalletAuthPageConfirmResult()
oAuthResult.error = NSError(
domain: "OAuthError",
code: IAPWalletBaseServiceResult.ERROR_CODE_USER_CANCEL,
userInfo: [NSLocalizedDescriptionKey: "USER CANCEL"]
)
callback(oAuthResult)
}
let confirmAction = UIAlertAction(title: "YES", style: .default) { _ in
let cacheAuthKey = "xxx"
UserDefaults.standard.set(true, forKey: cacheAuthKey)
callback(IAPWalletAuthPageConfirmResult(referenceAgreementId: "AGREEMENT_ID"))
}
alertController.addAction(cancelAction)
alertController.addAction(confirmAction)
DispatchQueue.main.async {
UIApplication.shared.keyWindow?.rootViewController?.dismiss(animated: true, completion: {
UIApplication.shared.keyWindow?.rootViewController?.present(alertController, animated: true)
})
}
}
}