🚀 Getting Started
Complete these steps to unlock the full platform
npm i @shophub/sdk
API Keys
Manage your API access credentials
Your API Keys (3)
| Key Name | API Key | Created | Last Used | Permissions | Status | Actions |
|---|---|---|---|---|---|---|
| Production Key |
sk-sh-****-****-a4f2
|
Jan 12, 2025 | 2 mins ago | read:products write:orders read:analytics | Active | |
| Development Key |
sk-sh-****-****-b9c1
|
Jan 15, 2025 | 1 hour ago | read:products read:orders | Active | |
| Analytics Key |
sk-sh-****-****-d7e5
|
Jan 20, 2025 | 3 days ago | read:analytics read:users | Expiring |
Documentation
Everything you need to build with ShopHub
🚀 Quickstart Guide
Welcome to the ShopHub API! This guide will help you make your first API call in under 5 minutes. Our REST API lets you manage products, process orders, handle payments, generate AI content, and access analytics — all from your app.
All requests must be made over HTTPS. We use standard HTTP response codes and return JSON for all responses.
🔒 Authentication
Authenticate by passing your API key in the Authorization header as a Bearer token:
Authorization: Bearer sk-sh-your-api-key-here
Content-Type: application/json
X-ShopHub-Version: 2024-01-01
🌐 Base URL
https://api.shophub.io/v1
📋 API Endpoints
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /products |
List all products in your store | ✅ Required |
| POST | /orders |
Create a new order | ✅ Required |
| GET | /wallet/balance |
Retrieve wallet balance and transactions | ✅ Required |
| POST | /wallet/transfer |
Initiate a wallet transfer | ✅ Required |
| POST | /ai/generate-description |
AI-generate a product description | ✅ Required |
| GET | /analytics |
Fetch store analytics and reports | ✅ Required |
| POST | /webhooks |
Register a new webhook endpoint | ✅ Required |
| GET | /users/me |
Get current authenticated user info | ✅ Required |
Webhooks
Subscribe to real-time events from your ShopHub store
Active Webhooks (4)
Available Event Types
Subscribe to any combination of these events
Delivery Log
| Time | Event | Endpoint | Response | Duration |
|---|---|---|---|---|
| 14:32:01 | order.created | /webhooks/orders | 200 OK | 124ms |
| 14:28:44 | payment.received | /webhooks/payments | 200 OK | 88ms |
| 14:11:22 | product.updated | /webhooks/inventory | 200 OK | 201ms |
| 13:55:08 | order.created | /hooks/shophub | 503 Error | 5002ms |
| 13:40:17 | order.shipped | /webhooks/orders | 200 OK | 97ms |
Plugin Marketplace
Extend ShopHub with powerful integrations
Usage Stats
Monitor your API usage and quota
📊 Top Endpoints
GET /products
POST /orders
GET /analytics
POST /ai/describe
GET /wallet/balance
GET /users/me