Boxo Connect

​

Introduction

​

Boxo Connect flow

1. The user opens the host app and launches the mini app.
2. To proceed, the user must be identified (e.g., for product purchases or user registration).
3. The mini app calls Boxo.login().
4. The user is prompted to confirm access to their personal data required for authorization.
5. The Boxo native SDK retrieves an authorization code from the host app and sends an HTTPS request to the Boxo platform.
6. The Boxo platform forwards the authorization code via an HTTPS request to the host app backend.
7. The host app backend validates the authorization code and returns an access token.
8. The Boxo platform sends an HTTPS request with the access token to the host app backend to retrieve user data.
9. The host app backend validates the access token and returns user data.
10. The Boxo platform forwards the user data via an HTTPS request to the mini app backend.
11. The mini app backend registers a new user or identifies an existing one, then issues an authorization token to the Boxo platform.
12. The Boxo platform returns the authorization token to the Boxo native SDK.
13. The authorization token is passed to the mini app.
14. The mini app sends a request with the authorization token to the mini app backend to retrieve user data.
15. The mini app backend validates the authorization token and returns the user data.
16. The user is successfully authorized and can proceed within the mini app.

​

Setting up the backend

​

Get access token

• Default <prefix>: Token. Access token prefix can be set in Boxo Connect.
• hostapp_client_id and hostapp_secret_key must be provided in Dashboard

• Response status must be 200 in all cases
• Response body:

    curl --location --request POST '[YOUR_SERVER_URL]/api/get_access_token/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic {{BASE64_ENCODED_CLIENT_ID_AND_CLIENT_SECRET}}' \
    --data-raw '{ "authCode": "{{HOSTAPP_AUTH_CODE_THAT_COMES_FROM_SDK}}" }'

​

Get user data

• This endpoint must handle a HTTPS GET request
• URL to endpoint must be provided in Dashboard

• Response status must be 200 in all cases
• Response body:

    curl --location --request GET '[YOUR_SERVER_URL]/api/get_user_data/'\
    --header 'Content-Type: application/json' \
    --header 'Authorization: Token {{ACCESS_TOKEN}}'

• email
• phone
• first_name
• last_name

​

Setting up the SDK

​

iOS

let miniapp = Boxo.shared.getMiniapp(appId: "app_id")
miniapp.delegate = self
miniapp.open(viewController: self)
...
extension ViewController : MiniappDelegate {
    func onAuth(miniapp: Miniapp) {
        miniapp.setAuthCode(authCode: "[AUTH_CODE]")
    }
}

​

Android

val miniapp = Boxo.getMiniapp("app_id")
miniapp.setAuthListener { boxoActivity, miniapp ->
    //get AuthCode from hostapp backend and send it to miniapp
    //use boxoActivity to open dialogs or activity
    miniapp.setAuthCode("auth_code")
}
miniapp.open(activity)

​

Flutter

Boxo.openMiniapp('app_id');
Boxo.lifecycleHooksListener(
    onAuth: (appId) { // called when authorization flow starts
        //get AuthCode from hostapp backend and send it to miniapp
        Boxo.setAuthCode('app_id', 'auth_code');
    }
);

​

ReactNative

Boxo.openMiniapp('app_id')
Boxo.lifecycleHooksListener({
    onAuth: (appId: string) => {
        //get AuthCode from hostapp backend and send it to miniapp
        Boxo.setAuthCode('app_id', 'auth_code');
    },    
});

​

Get user consent

• This is HTTPS GET /api/v1/accounts/consent/get_consent/ endpoint

​

Query Parameters:

{
   “is_consented”: <Bool>
}