Skip to content

Commit

Permalink
add install flows guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alexphelps committed Dec 13, 2024
1 parent cbec377 commit 418c413
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/apps/oauth/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_position: 1
---
# Getting Started with OAuth

Expand Down
25 changes: 25 additions & 0 deletions docs/apps/oauth/install-flows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 6
---

# Install Flows


### Private Apps
All apps start in a `private` state while the app developer is building and testing their app internally. While an app is `private`, you can use the "Install Link" builder form on your app detail page.

You may also want to trigger the install flow from your app's UI, to do this you can add a form build the install link for your user to start the install flow.

```python title="Install Link"
https://{store_subdomain}.29next.store/dashboard/apps/install-app/?client_id={client_id}
```

|Parameter|Description|
|-----|-----|
|`store_subdomain`| The store subdomain. |
|`client_id`| Your app Client ID found on the app detail page. |


### Public Apps

Public apps show in all store dashboards and can be installed by any merchant at any time. If you plan to publish your app, ensure your app handles the install flow with a good user experience that guides the user through the process with your app.
1 change: 1 addition & 0 deletions docs/apps/oauth/session-auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_position: 2
---

# Session Token Overview
Expand Down

0 comments on commit 418c413

Please sign in to comment.