Create Private App at Store Admin
Shoplazza requires private app to have Access Token authentication before it can use Shoplazza Open API.. Therefore, before you start the public development phase, you need have ask merchants to complete the following steps to create an private app for you in Shoplazza Store Admin:
- Log in to Shoplazza Store Admin.
- Worldwide:https://www.shoplazza.com/
- China:https://www.shoplazza.cn/
Log in to your account or create a new user account.
After logging in, you can access the Store Admin’s index page.
Click the "Apps" menu:
- Click Manage Private Apps
- Click "Create App"
Access to the Shoplazza Admin API requires permissions, and different APIs require different access permissions.
| API Access URL | scope |
|---|---|
| /products | product |
| /variants | product |
| /collections | collection |
| /collects | collection |
| /payments_apps | payment_info |
| /orders | order |
| /shop | shop |
| /price_rules | price_rules |
| /discount_codes | price_rules |
| /coupons | price_rules |
| /discount_flashsales | price_rules |
| /discount_rebates | price_rules |
| /popups | price_rules |
| /salespops | price_rules |
| /redirects | shop_navigation |
| /themes | themes |
| /comments | comments |
| /script_tags | script_tags |
| /customers | customer |
| /gift_cards | gift_cards |
| /products | product |
| /pages | shop_navigation |
| /app-proxys | app_proxy |
| /datas | data |
| /app-proxies | app_proxy |
| /data/ | data |
- Enter the Private app name, Emergency developer email, select the Webhook API version and Permissions for your app.
- Click "Save"
The system automatically creates an Access token、Access token and Access token，you can see it by clicking the private app name.
After the private app is created, you should ask merchants to provide the private app AccessToken to you, so you can start developing the private app by making authenticated request to Shoplazza Open API.
Note
Private app must have Access token before it can make authenticated request to Shoplazza Open API, refer to Access Token to learn more.
Fields of private app
To create a private app you need to fill in the following information:
| Field | Definition | Use of |
|---|---|---|
| Private app name | The name of the private app | Identify which private app in private app list in Shoplazza Store Admin - Private Apps |
| Emergency developer email | The email of the app developer | For merchants or Shoplazza platform to contact the private app developer if any emergency bug occurred in private app. |
| Webhook API version | The webhook API version of the private app | Private app using the webhook to receive the event callback from merchants store initiated by Shoplazza Platform. |
| Permissions | The permissions of the private app can use in Open API | Merchant should carefully control the permissions of the private app for the security concerns. Refer to Access Scopes. |
Prepare your application service
With the access_token, you can access the Shoplazza API , such as:
Testing your app
Testing of private applications does not require any configuration in the Shoplazza-related systems; it is only necessary to ensure that the corresponding services of the application are running stably.
With this, the creation of the private application is complete.