The ReCharge API Key Management integration was created to allow merchants to supply Shopify Private API keys and passwords in a safe and secure way. This guide walks through accessing the integration, generating a Shopify API key, and adding the key to ReCharge.
Before you begin
The ReCharge API Key Management integration is still in beta. To get access, send in a request to be added to the rollout list.
Step 1 - Access the integration
Once the integration has been enabled by ReCharge, it will show up under the Enabled integrations tab.
- Select Integrations on the top toolbar.
- Click on the Enabled integrations tab.
- ReCharge will display a list of all active integrations including ReCharge API Key Management
Step 2 - Add a Shopify Private app
Before you can add any keys and passwords to ReCharge, you need to generate a new private app on your Shopify store.
- Log into the Shopify Admin and navigate to Apps.
- Click on Manage private apps near the bottom of that page.
- Click the Create new private app button at the top.
- Supply a name and an email for the private app.
- Configure the permissions as listed on Shopify private app API Tokens with two exceptions.
- The permissions can be found on Creating a Shopify private app key.
- Leave Allow this app to access your storefront data using the Storefront API checkbox unchecked.
- Leave API version as the default.
- Copy the new API key and password to be inputted into the API Key Management integration.
Step 3 - Add key to ReCharge API Key Management integration
Initially, the integration will not have any keys registered, click the Add key button to get started.
When adding new keys, you will need to supply a name for the key, as well as the API key and password copied from Shopify.
If there are any missing or incorrectly set permissions, you will be alerted with an error message.
After the key has been added, it will show up in a list on the integration page.