Private apps
In this article, we will give you an overview of private apps and how to generate API credentials from the ShopBase admin.
A. Understand private apps
B. Generate API credentials from the ShopBase admin
C. Delete a private app
Apps on ShopBase can be divided into two groups:
Public apps: built to work with most ShopBase stores.
Private apps: built to work exclusively for your store.
Private apps can be used for several situations, such as:
Create an importer to migrate your data from platforms other than Shopify to ShopBase.
Integrate your store's data with a custom solution to manage your products, orders, or inventory outside of ShopBase.
Offer products from your ShopBase store on the custom storefront, such as a mobile app, website, or video game.
When you make an API call, you need to include API credentials to authenticate it. You can quickly generate API credentials by creating a private app from your store's ShopBase admin. When you create the private app, ShopBase creates an API key and password, which you can include in API calls to the store.
From your ShopBase admin site, go to Apps.
Click Manage private apps, near the bottom of the page.
Click Create a new private app.
In the App details section, enter a name for the private app and a contact email address. ShopBase uses the email address to contact the developer if there is an issue with the private app, such as when an API change might break it.
In the Admin API section, select the areas of your store that you want the app to be able to access.
Click Save.
After you save the app's details, the Admin API section shows the app's API key and password.
Regard your API key and password as your any other password, since whoever has access to these credentials has full API access to the store.
When you have no intention to use the private app, you can remove it from Apps page in your ShopBase admin.
From your ShopBase admin site, go to Apps.
Click Manage private apps.
Click the delete icon beside the app that you want to delete.
In this article
A. Understand private apps
B. Generate API credentials from the ShopBase admin
C. Delete a private app
A. Understand private apps
Apps on ShopBase can be divided into two groups:
Public apps: built to work with most ShopBase stores.
Private apps: built to work exclusively for your store.
Private apps can be used for several situations, such as:
Create an importer to migrate your data from platforms other than Shopify to ShopBase.
Integrate your store's data with a custom solution to manage your products, orders, or inventory outside of ShopBase.
Offer products from your ShopBase store on the custom storefront, such as a mobile app, website, or video game.
B. Generate API credentials from the ShopBase admin
When you make an API call, you need to include API credentials to authenticate it. You can quickly generate API credentials by creating a private app from your store's ShopBase admin. When you create the private app, ShopBase creates an API key and password, which you can include in API calls to the store.
From your ShopBase admin site, go to Apps.
Click Manage private apps, near the bottom of the page.
Click Create a new private app.
In the App details section, enter a name for the private app and a contact email address. ShopBase uses the email address to contact the developer if there is an issue with the private app, such as when an API change might break it.
In the Admin API section, select the areas of your store that you want the app to be able to access.
Click Save.
After you save the app's details, the Admin API section shows the app's API key and password.
Regard your API key and password as your any other password, since whoever has access to these credentials has full API access to the store.
C. Delete a private app
When you have no intention to use the private app, you can remove it from Apps page in your ShopBase admin.
From your ShopBase admin site, go to Apps.
Click Manage private apps.
Click the delete icon beside the app that you want to delete.
Updated on: 13/09/2022
Thank you!