Making your first request

This guide describes the basic steps for getting started with ShopBase's API. You can create your development stores to test your apps, themes, and other integrations that you build.

Welcome to ShopBase partner program!

Please follow our instructions below to get started.

Create a ShopBase store

First, create a regular ShopBase store (you will get 14-day free trial). In this step, please use the email you want to be your official Partner account.

Apply to become a ShopBase Partner

By joining ShopBase partner program, you can convert your regular store into a development store (unlimited free-trial access but with only 20 orders per month limit), so you can freely test your products.

You can register to become a ShopBase Partner by submitting this form, using the email you have just signed up for the regular store. We'll email you once your request is approved.

After being approved, you will have access to the Partner Dashboard and you can use your development store without submitting payment details. From your Partner Dashboard, you can manage the apps that you build on ShopBase.

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 development 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 development store.

To learn more about public and private apps, see Authentication.

Steps:

  1. From your ShopBase admin, go to Apps.

  2. Click Manage private apps.

  3. Click Create a new private app.

  4. In the App details section, enter a name for your app, and an emergency developer email.

  5. In the Admin API section, select the areas of your store that you want the app to access.

  6. Click Save.

After you save the app's details, the Admin API section shows the app's API key and password.

Caution

Treat the API key and password like you would any other password, since whoever has access to these credentials has full API access to the store.

Making your first request

You can use the API key and password that you generated for basic HTTP authorization of your first request. The URL format for basic authorization is as follows:

https://{username}:{password}@{shop}.onshopbase.com/admin/{resource}.json
  • {username} — The API key that you generated

  • {password} — The API password

  • {shop} - The name that you entered for your development store

  • {resource} — A resource endpoint from the REST admin API

A URL with real values looks like this:

https://38b3692b6b48a9712b8d909c46e6208d:c2dc0abbdef5825da69ee1647962ce2d@example.onshopbase.com/admin/products.json

The following curl request retrieves information by using the Shop resource and the /admin/shop.jsonendpoint:

curl -X GET https://{username}:{password}@{shop}.onshopbase.com/admin/shop.json -H 'Content-Type: application/json'

Substitute your own values, and then run the curl command from the command line to retrieve information from your development store.

Sample App

You can use SampleApp from this bitbucket repo as a reference for understanding authentication flow of a ShopBase app and how to call ShopBase APIs with public app.