Skip to content

Commit 8e61290

Browse files
Rename integration flags
1 parent 6774344 commit 8e61290

2 files changed

Lines changed: 27 additions & 10 deletions

File tree

docs/digital-wallets/intro.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,24 @@ These payment options offer a seamless and convenient way for your customers to
1515
### Mobile integration:
1616

1717
- If you are redirecting to Topper through the user's browser, no extra configuration is necessary.
18-
- When Topper is embed with a `WebView`, ensure setting `is_android_app=1` or `is_ios_app=1` as a query parameter in the URL.
18+
- When Topper is embed with a `WebView`, ensure setting `is_android_webview=1` or `is_ios_webview=1` as a query parameter in the URL.
1919
- When Topper is opened using a `Safari View Controller`, ensure setting `is_safari_view_controller=1` as a query parameter in the URL.
20+
21+
:::caution Deprecated Parameters
22+
The parameters `is_ios_app` and `is_android_app` are now renamed to `is_ios_webview` and `is_android_webview`.
23+
24+
Legacy parameters are still supported but **deprecated**.
25+
26+
Please migrate to the new parameter names to ensure future compatibility.
27+
:::
2028

2129
**Example URLs:**
22-
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_app=1`
23-
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_app=1`
30+
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_webview=1`
31+
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_webview=1`
2432
- Safari View Controller: `https://app.topperpay.com/?bt=<bootstrap token>&is_safari_view_controller=1`
2533

2634
**Using the [Web SDK](../web-sdk.md):**
2735

28-
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_app: true } });`
29-
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_app: true } });`
36+
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_webview: true } });`
37+
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_webview: true } });`
3038
- Safari View Controller: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_safari_view_controller: true } });`

docs/single-sign-on.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,23 @@ This creates a better experience for users because they can use their existing c
4141
**Notes:**
4242

4343
- If you are redirecting to Topper through the user's browser, no extra configuration is necessary.
44-
- When Topper is embed with a `WebView`, ensure setting `is_android_app=1` or `is_ios_app=1` as a query parameter in the URL.
44+
- When Topper is embed with a `WebView`, ensure setting `is_android_webview=1` or `is_ios_webview=1` as a query parameter in the URL.
45+
46+
47+
:::caution Deprecated Parameters
48+
The parameters `is_ios_app` and `is_android_app` are now renamed to `is_ios_webview` and `is_android_webview`.
49+
50+
Legacy parameters are still supported but **deprecated**.
51+
52+
Please migrate to the new parameter names to ensure future compatibility.
53+
:::
4554

4655
**Example URLs:**
4756

48-
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_app=1`
49-
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_app=1`
57+
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_webview=1`
58+
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_webview=1`
5059

5160
**Using the [Web SDK](./web-sdk.md):**
5261

53-
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_app: true } });`
54-
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_app: true } });`
62+
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_webview: true } });`
63+
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_webview: true } });`

0 commit comments

Comments
 (0)