Subscribfy API Key
Authenticate API requests with your unique Subscribfy API key
Your Subscribfy API key is a unique identifier that authenticates requests to Subscribfy APIs. Use it to integrate with membership management, store credits, churn prevention, and more.
Keep Your API Key Private
Never share your API key publicly or commit it to version control. Treat it like a password.
Finding Your API Key
Open Subscribfy
From your Shopify admin, go to Apps → Subscribfy.
Go to Integrations
Click Integrations in the left sidebar.
Copy Your API Key
Your API key is displayed at the top of the page. Click the clipboard icon to copy it.
APIs That Use This Key
Your Subscribfy API key authenticates requests to these endpoints:
Membership Management
Manage customer memberships programmatically
Churn Prevention
Access and activate churn offers for subscriptions
Collection API
Fetch customer collections and segments
Some integrations like Gorgias use the API key automatically behind the scenes. You don't need to manually configure it for those.
Using the API Key
Include the key parameter in your API requests:
curl -X POST "https://yourstore.myshopify.com/apps/subscribfy-laravel/api/v1/membership/manage" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "key=YOUR_API_KEY" \
-d "customer_email=customer@example.com"| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Your Subscribfy API key |
Security Best Practices
Server-Side Only
Only use the API key in server-side code. Never expose it in frontend JavaScript.
Environment Variables
Store the key in environment variables, not in code files.
Rotate if Compromised
Contact support to regenerate your key if it's ever exposed.
Do's and Don'ts
| Do | Don't |
|---|---|
| Store in environment variables | Hardcode in source files |
| Use server-side only | Expose in frontend code |
| Keep in secure password manager | Share via email or chat |
| Regenerate if compromised | Ignore potential leaks |
Troubleshooting
Related
Was this page helpful?