Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

App management intro and sample flows #783

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

App management intro and sample flows #783

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
65f9804
intro template
SimonC24 Jan 9, 2024
8506dfe
Terminology
SimonC24 Jan 9, 2024
4f021b4
use case headings
SimonC24 Jan 10, 2024
13feaa8
initial use cases
SimonC24 Jan 10, 2024
9045f04
use case adjustments
SimonC24 Jan 10, 2024
d950dcd
Sample flow ideas
SimonC24 Jan 16, 2024
c7d115c
Use case changes
SimonC24 Jan 17, 2024
4bcb238
auto login motivation
SimonC24 Jan 17, 2024
d774628
Adjusted Wix App flow
SimonC24 Jan 17, 2024
8d0a4dd
terminology reorg
SimonC24 Jan 17, 2024
4586d97
removed before you begin
SimonC24 Jan 17, 2024
d604f9b
rephrased into paragraph
SimonC24 Jan 17, 2024
5b37dcc
Removed sample flows
SimonC24 Jan 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 41 additions & 8 deletions app-management/guides/About App Management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,41 @@
# About App Management
The Wix App Management APIs provide your app with access to basic user data and specific app functionality.

- The [App Instance API](https://dev.wix.com/api/rest/app-management/apps/app-instance/introduction) exposes basic data about the site and your app installed on it.
- The [Billing API](https://dev.wix.com/api/rest/app-management/apps/billing/introduction) enables your app to lead customers seamlessly into Wix's checkout process from your platform.
- The [Embedded Scripts API](https://dev.wix.com/api/rest/app-management/apps/embedded-scripts/introduction) enables your app to inject custom script tags to the site's <head> tag.
- The [BI Events API](https://dev.wix.com/api/rest/app-management/apps/bi-event/introduction) enables your app to send BI events to the Wix system.
- The [Editor Deep Link API](https://dev.wix.com/api/rest/app-management/about-the-editor-deep-link-api) (Beta) enables your app to link to a URL that hat opens the Editor and adds an app's Custom Element component to the site's page.
# About the App Management APIs

The App Management APIs allow you to manage user specific data for all individual
installations of your app. This includes receiving notifications whenever a new
user installs your app on their site or purchases a Premium version. Additionally,
you can use the APIs to implement an external pricing page and manage usage-based
pricing.

With the App Management APIs, you can:

+ [Track user specific data with app instance IDs](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/introduction)
+ [Manage usage-based pricing](https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/custom-charges-provider-v1/introduction)
+ [Add embedded scripts to Wix sites](https://dev.wix.com/docs/rest/api-reference/app-management/apps/embedded-scripts/introduction)
+ [Notify Wix about your app's business events](https://dev.wix.com/docs/rest/api-reference/app-management/apps/bi-event/introduction)

Learn more about:

+ [Identifying users with App Instance ID](https://dev.wix.com/docs/build-apps/build-your-app/app-instance/identify-users-app-instance)
+ [Pricing options for your app](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing)
+ [Setting up embedded scripts](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts)

## Use cases

+ [Reach out to new users](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/sample-flows#reach-out-to-new-users)
+ [Manage usage-based invoices](https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/sample-flows#bill-a-customer)
+ [Identify a site's installed Wix business solutions](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/sample-flows#identify-a-sites-installed-wix-business-solutions)
+ [Automatically log users in to your app](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/sample-flows#automatically-log-users-in-to-your-app)

## Terminology

+ __App Instance__: Unique identifier of an app within a specific website. The
app instance ID is ideal for identifying your users, the specific plan they’ve
purchased from you and the features you're supporting for them.
+ __App Pricing__: You can choose the business model that works best for your app.
Use the [Custom Charges SPI](https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/custom-charges-provider-v1/introduction)
to manage your app's usage-based pricing.
+ __Usage-based pricing__: You charge your users on a recurring, monthly basis.
You can include a flat base fee and other fees if you want.
+ __Custom Charge__: Adjustable price for using your app. Each billing cycle
you can add up to 5 charges to an invoice that Wix sends to your customer.
+ __Embedded script__: Script that you can add to a site's `<head>` tag.