Home Getting Started Connect Partner API

Connect Partner API

Last updated on Aug 13, 2026

Connect your Shopify Partner account to Ranksy to track revenue, customers, subscriptions, and business metrics for your app.

What You'll Get

Once connected, Ranksy automatically imports:

  • Revenue Data: Daily, weekly, monthly earnings
  • MRR (Monthly Recurring Revenue): Predictable income tracking
  • Customer Count: Total paying customers
  • New Installs: Recent app installations
  • Churn: Customers who cancelled
  • Subscription Changes: Upgrades and downgrades
  • Customer Details: Complete merchant information

Before You Start

Make sure you have:

✅ Access to your Shopify Partner Dashboard ✅ Admin permissions for your app ✅ 5-10 minutes to gather credentials

Step 1: Get Your Credentials from Shopify

You need three pieces of information from your Shopify Partner Dashboard.

1. Organization ID

  1. Log into partners.shopify.com
  2. Click Settings (gear icon in top right)
  3. Go to Partner account settings
  4. Find your Organization ID (looks like: 123456)
  5. Copy this number

2. App ID

  1. In Partner Dashboard, go to Apps
  2. Click on your app
  3. Look at the URL in your browser address bar
  4. The URL looks like: partners.shopify.com/123456/apps/789012
  5. The last number (789012) is your App ID
  6. Copy this number

3. API Access Token

Shopify generates this token from a Partner API client. (This replaces the older single-use "API access" keys.)

  1. In your Partner Dashboard, click Settings (gear icon in the top right)
  2. Scroll down to the Partner API clients section
  3. Click Manage Partner API clients
  4. Click Create Partner API client
  5. Give it a name like Ranksy
  6. Under Permissions → Permission sets, tick:
    • ✅ View financials (required — for earnings and revenue)
    • ✅ Manage apps (required — for app events and installs)
    • Leave Manage themes unchecked
  7. Save to create the client
  8. Open the client and find the Credentials section
  9. Next to Access token, click Show (or the copy icon) and copy the token

💡 Good to know: Unlike the old API keys, you can view and copy this access token again anytime from the same screen — it isn't shown only once. To rotate credentials later without downtime, use Generate secondary token instead of deleting the client.

⚠️ Important: Treat this access token like a password. Don't share it or commit it to code repositories.

Step 2: Enter Credentials in Ranksy

Now let's connect your Partner account to Ranksy.

Navigate to Settings

  1. In Ranksy, go to My Apps
  2. Click on your app
  3. Click Settings in the app navigation

Enter Your Credentials

In the "Shopify Partner API" section:

  1. Enter your Organization ID
  2. In the API Key field, paste the Partner API client Access token (it will be masked as you type)
  3. Enter your App ID
  4. Click "Save Configuration"

That's it! Ranksy will immediately start syncing your data.

What Happens After Save?

When you click "Save Configuration":

  1. Ranksy validates your credentials
  2. A sync is automatically triggered
  3. Historical data starts importing
  4. You'll see a success message

Note: There's no separate "Start Sync" button - saving your credentials automatically starts the import process.

Step 3: Monitor the Sync

Check Sync Status

The Settings page shows:

  • Last sync time
  • Sync status (Connected, Syncing, Error)
  • Number of records imported

How Long Does It Take?

First sync duration depends on your data:

  • New app (< 6 months): 15-30 minutes
  • Established app (6-24 months): 30-60 minutes
  • Mature app (2+ years): 1-2 hours

You can close the page - sync continues in the background.

Verify Data Appeared

After the initial sync completes:

  1. Go to your app's Dashboard — the Revenue widget should now show live data
  2. Click into the Revenue hub in the sidebar
  3. You should see:
    • Revenue charts (Overview tab)
    • Customer counts (Customers tab)
    • MRR tracking (Earnings tab)
    • Subscription metrics (Subscriptions tab)

Managing Your Connection

Manual Sync Options

After configuration, two sync options appear:

Incremental Sync

  • Imports only new/changed data
  • Faster (a few minutes)
  • Use for regular updates
  • Click the "Incremental Sync" button

Full Sync

  • Re-imports all historical data
  • Slower (same as initial sync)
  • Use if data looks incorrect
  • Click the "Full Sync" button
  • Requires confirmation (it deletes existing data first)

Automatic Syncing

Once connected, Ranksy automatically syncs:

  • Daily: Overnight (typically 2-3 AM)
  • Incremental: Only new/changed data
  • No action needed: It just works!

Update Credentials

If you need to change credentials:

  1. Go to your app Settings
  2. Update the fields
  3. Click "Save Configuration"
  4. New sync starts automatically

Disconnect

To disconnect the Partner API:

  1. Go to your app Settings
  2. Find the Partner API section
  3. Click "Disconnect"
  4. Confirm the disconnection
  5. Historical data is preserved for 90 days

Troubleshooting

Error: "Invalid Organization ID"

Fix:

  • Double-check you copied the complete number
  • Make sure there are no spaces before/after
  • Verify it's the Organization ID, not the App ID
  • Try copying it again from Shopify

Error: "Invalid API Key"

Fix:

  • The token is case-sensitive - copy it exactly
  • No spaces at the beginning or end
  • Re-copy the Access token from your Partner API client (Settings → Partner API clients → your client → Credentials → Show) — it's viewable anytime
  • Make sure View financials and Manage apps are both ticked on the API client's permissions

Error: "App Not Found"

Fix:

  • Verify the App ID is correct
  • Make sure it's the App ID, not Organization ID
  • Check the URL format in Partner Dashboard matches partners.shopify.com/ORG_ID/apps/APP_ID
  • Ensure you have permissions for this app

Sync Stuck or Taking Too Long

What to try:

  • Large apps can take 2-4 hours for initial sync
  • Check the sync status on Settings page
  • Wait at least 4 hours before troubleshooting
  • Try clicking "Full Sync" if stuck
  • Contact support if stuck for more than 6 hours

Data Doesn't Match Partner Dashboard

Fix:

  • Click "Full Sync" to refresh all data
  • Check that date ranges match exactly
  • Some metrics are calculated differently (I use different time zones or aggregation methods)
  • If still mismatched after full sync, contact support

Security & Privacy

How Ranksy Handles Your Data

Credentials:

  • Encrypted at rest (AES-256)
  • Encrypted in transit (TLS/SSL)
  • Never stored in plain text
  • Access is logged and monitored

Data Access:

  • Read-only access to your Partner data
  • I NEVER modify your Shopify data
  • Your data stays yours
  • Isolated per account

Compliance:

  • GDPR compliant
  • SOC 2 practices followed
  • Regular security audits
  • Data processing agreements available

FAQ

Q: Is the Partner API free to use? A: Yes! Shopify's Partner API is free within reasonable usage limits.

Q: Will this affect my Shopify billing? A: No. Connecting the Partner API doesn't change your Shopify costs.

Q: Can I connect multiple apps? A: Yes! Connect each app separately using the same or different credentials.

Q: What if my access token leaks? A: Open your Partner API client and click Generate secondary token to rotate the access token (or delete the client to revoke access entirely), then paste the new token into Ranksy.

Q: Can I pause syncing? A: Yes. Disconnect the integration in Settings. You can reconnect anytime.

Q: How often should I manually sync? A: You don't need to! Automatic daily syncs keep your data current. Only use manual sync if you need real-time data or troubleshooting.

Next Steps

Now that Partner API is connected:

Need help? Contact [email protected] or use the chat widget. Include your app name and any error messages.