API Keys & Integrations
Step 1: Accessing API Settings
- Go to Settings → API
- Or navigate to /store/[key]/settings/api
- You'll see API keys list
Step 2: Understanding API Keys
- API Key: Public identifier for your API
- API Secret: Private key (keep secure)
- Description: Name for your API key
- Permissions: What API can access
- Activated: Whether API is active
Step 3: Creating API Key
- Click "Add API" or "Create" button
- API form modal opens
- Enter Description:
- Type descriptive name
- Example: "Mobile App Integration"
- Generate API Key:
- System generates key automatically
- Copy key immediately
- Generate API Secret:
- System generates secret automatically
- Copy secret immediately
- Set Permissions:
- Select what API can do:
- Read Customers
- Write Customers
- Read Orders
- Write Orders
- Read Products
- Write Products
- Read Categories
- Write Categories
- Check permissions needed
- Activate API:
- Toggle "Activated" switch
- API is active
- Save API Key:
- Click "Save" button
- API key is created
- Appears in list
Step 4: Viewing API Keys
- API keys listed in table
- Each key shows:
- Activated status (checkmark/X)
- Description
- API Key (masked)
- API Secret (masked)
- Actions
- Click eye icon to reveal keys
- Keys are masked by default
Step 5: Editing API Key
- Find API key in list
- Click "Edit" icon
- Edit form opens
- Modify:
- Description
- Permissions
- Activation status
- Update API Secret if needed
- Click "Save" to update
Step 6: Deleting API Key
- Find API key to delete
- Click "Delete" icon
- Confirmation appears
- Confirm deletion:
- Click "Delete" button
- API key is removed
- API access is revoked immediately
Step 7: Setting Up Webhooks
- Go to Settings → Webhooks
- Or navigate to /store/[key]/settings/webhooks
- You'll see webhooks list
Step 8: Creating Webhook
- Click "Add Webhook" button
- Webhook form opens
- Enter Webhook URL:
- Type endpoint URL
- Must be valid URL
- Example: https://your-server.com/webhook
- Select Event:
- Choose event type:
- Order Create
- Event triggers webhook
- Save Webhook:
- Click "Save" button
- Webhook is created
- Appears in list
Step 9: Testing Webhook
- Find webhook in list
- Click "Send Dummy" button
- Test request is sent
- Terminal shows response:
- Status code
- Response body
- Any errors
- Verify webhook works correctly
Step 10: Managing Webhooks
- View webhook details:
- ID
- URL
- Event type
- Delete Webhook:
- Click "Delete" icon
- Confirm deletion
- Webhook is removed
API Keys & Integrations Tips
- Use descriptive API key names
- Keep API secrets secure
- Grant minimum necessary permissions
- Test webhooks before production
- Monitor API usage regularly
- Delete unused API keys
- Rotate API keys periodically
- Use HTTPS for webhooks