Getting started with Shopify's API
You can use Shopify's APIs to create powerful ecommerce solutions for a variety of purposes, including integrating your service with Shopify, adding new capabilities to the Shopify admin, and embedding Shopify-powered ecommerce features in any website.
This guide describes the basic steps for getting started with Shopify's API: signing up for a Shopify Partner account, creating a development store where you can test your app, generating the required API credentials, and then making API calls to Shopify against a single shop.
Create a Shopify Partner account
The Shopify Partners program includes developers, designers, and experts who build on the Shopify platform. You can sign up for a free Shopify Partner account by registering here.
From your Partner Dashboard, you can create development stores. Development stores provide an area for app development where you can create data to test out your app.
Create a development store
You can use development stores to build Shopify stores for clients, and to test your apps, themes, or other integrations.
To create a development store:
Log in to your Partner Dashboard.
Click Development stores.
Enter the following details about your new development store:
- The store name
- A password for the store login
When you're done, click Save.
To learn more about development stores, including their features and limitations, see Creating development stores.
After you've created a development store, your next step is to create your app.
Generate API credentials from the Shopify admin
Before you can start making authenticated API calls to Shopify, you need to generate the required credentials from the Shopify admin of the store that you want to connect with your application.
To generate the required credentials:
From your Shopify admin, go to Apps.
Click Manage private apps.
Click Create new private app.
In the Description section, enter a Private app name.
In the Admin API section, select the areas of your store that you want the app to be able to access.
You'll see your API key and password in the Admin API section. These credentials are required when you make authenticated requests to the Shopify store that uses your application.
Making your first request
Private applications authenticate with Shopify through basic HTTP authorization. When you create a private app in your development store, you receive the credentials that you'll need to authenticate the app: its unique API key (which is treated as the username) and password.
To use the API to get information about the shop that you just created, make a simple request to the
shop endpoint. Here's an example using
curl -H "Content-type: application/json" 'https://username:firstname.lastname@example.org/admin/shop.json'
Now that you've made an API call to a single shop, you're ready to learn how to install an app on multiple shops.
Next step: Authentication