Skip to main content

Publish your App

1. Deploy your app to your remote servers​

Once you app is ready to go, you should deploy your application to your own remote servers.

2. Request Bam Hub access​

A Bam Hub is required for your development team to manage your app(s). By using the REST API you can create apps, revisions and installation keys belonging to your Bam Hub.

To request a Bam Hub, email app-framework@bambuser.com and include the following:

  • Organization you are associated with
  • Reason of why you are building an app

3. Create your app​

The REST API allows you to create an app entity, it will be given a unique Bambuser generated App ID.

Change your entry point​

Remember to update your entrypoint to a valid url that is accessible from the internet. During development you have probably used something like http://localhost:3000. That needs to be changed to the url of your remote servers in order for your app to work for other users.

Adjust your permissions to the ones your app requires​

During development you may have run with allowing all permissions in order to simplify development. While this is fine for development, it is not recommended for production. This is because when a merchant installs your app in their Bam Hub, they will be asked to approve the permissions you have requested. If you request too many permissions, the merchant may not approve your app.

Therefore, before you publish your app, make sure to narrow down the permission only to the ones your app requires.

3. Installation keys for selected Bam Hubs​

A Bam Hub is the place where employees from the merchant control their settings, use the Bambuser products or install your apps. Each Bam Hub is normally linked with one merchant website, for example their e-com site in a specific country. Merchants can have multiple Bam Hubs, for example one for each country they operate in, but they can also use more or less depending on their needs.

A merchant will need to install your app in each Bam Hub they want it to be available in. But you as the app owner will be in charge of which Bam Hubs may actually install it, with the REST API you can create your installation keys. You should then share both your App ID and the installation key with the merchant so they can use the REST API themselves to install your app to their Bam Hub. In the case that you are developing an app extension for your own company and not for any other merchants on the Bambuser platform, installation keys are not needed when installing the app to the same Bam Hub.

Organization ID

Merchant's organization ID can be found in Bambuser workspace URL

  • https://lcx.bambuser.com/[YOUR_ORG_ID]/...

App Configurations​

When an app is installed to a Bam Hub, each Bam Hub may have their specific configuration needs, some apps may even require some configuration to be set up before they can be used. This may be things as simple as a color scheme or more complex things like API keys.

In coordination with the merchant you will need to instruct them to use the REST API to initially provide or update the publicConfig of the app installation according to your and the merchant's needs.

Marketplace​

Bambuser App Framework is in its early stages and we are currently working on a marketplace where merchants can find and install apps. Until the marketplace is ready, you will need to communicate with the merchant to make them aware of your app and both you and the merchant to use the REST API to manage your app and app installation.