Introduction
Choosing the Right API Product
Section titled “Choosing the Right API Product”| Feature / Property | Standalone API | Shopify API |
|---|---|---|
| Primary Use Case | Custom web applications, backend services, WooCommerce | Shopify merchants using the Shopify App (e.g. Avada Joy, Yotpo, LoyaltyLion) |
| Base URL | https://app.thegoodapi.com | https://sprout-app.thegoodapi.com/app/api |
| Authentication | Authorization: live_sk_abc123 (Bearer key or raw key) | api_key: PROD-xxxx or TEST-xxxx + shop_name: store.myshopify.com |
| Billing Model | Billed directly via Stripe metered usage or credit card | Billed via Shopify App Top-Up Balances (AppUsagePricing) |
| Key Generation | Dashboard at thegoodapi.com | Shopify Admin -> App -> API & Developer Settings |
| Verify Endpoint | GET /dashboard_url | GET /app/api/verify |
| Impact Endpoints | /plant/trees, /rescue/plastic_bottles, /charities/* | /app/api/plant, /app/api/plastic, /app/api/charity/donate |
| Documentation Guide | Standard API Docs below | Shopify API Guide |
Why use GoodAPI?
Section titled “Why use GoodAPI?”Plant a tree after any event in your app — a subscription, a product purchase, or any customer milestone. Showcase your investment in the planet and drive more conversions.
Put impact on autopilot. No manual tracking, no manual payments — we plant trees on your behalf and invoice you once a month. Every tree comes with an updated record and a certificate as proof of planting.
Sign up for Standalone API
Section titled “Sign up for Standalone API”Create an account and grab your API keys at app.thegoodapi.com/fe/login. Signup is self-serve — no invite needed.
Every account comes with two keys:
- Production key (
api_key_prod) — real impact. Trees planted with this key are added to your end-of-month invoice. - Test key (
api_key_test) — behaves identically, but doesn’t trigger charges or real-world impact. Use it in staging and local development.
Use the keys in the Authorization header on every API request:
Authorization: <your_api_key>Billing
Section titled “Billing”Invoices are emailed to you each month and are payable directly from the email. You can also set up auto-pay from your account.