Launch API integrations quickly with clear endpoint patterns.
Sedifex Developer Platform
Ship your Sedifex integration in 5 minutes.
Build storefront, CMS, and partner integrations with store-scoped API keys, signed webhooks, and a developer console designed for fast onboarding.
Build faster with real-world integration workflows
Secure event delivery with webhook signing and replay-safe validation.
Monitor key usage, audit activity, and reliability from one console.
Information Architecture (v1)
Public (No Login)
- Home
- Quickstart
- API Reference
- Webhooks
- Guides
- Troubleshooting
Authenticated Console
- Overview: active keys, webhook status, recent errors
- API Keys: create, revoke, rotate, last-used metadata
- Webhooks: endpoint setup, secret management, test delivery
- Audit Logs: key and webhook lifecycle actions
- Team & Access: invite + role management by workspace/store
First 5 Endpoints to Launch
GET /integrationProducts?storeId=<storeId>
Read products for authorized partner integrations.
POST /developer/keys
Create a store-scoped integration key (secret shown once).
POST /developer/keys/{keyId}/revoke
Immediately invalidate a compromised or unused key.
POST /developer/webhooks
Register endpoint URL and per-endpoint signing secret.
POST /developer/webhooks/{endpointId}/test
Send signed test event to validate setup before go-live.
RBAC Matrix (Recommended)
| Role | Read Docs | Read Products API | Manage API Keys | Manage Webhooks | View Audit Logs | Manage Team |
|---|---|---|---|---|---|---|
| Public | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Developer (invited) | ✅ | ✅ | ✅ (assigned store) | ✅ (assigned store) | ✅ | ❌ |
| Manager/Admin | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ (except ownership transfer) |
| Owner | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Onboarding Flow (Exact Login Path)
- Developer lands on public docs.
- Clicks Create Integration and is redirected to Sedifex Auth.
- If user has no account, complete self-signup or invite-based signup.
- After login, backend validates
teamMembers+storeId. - If authorized, show console for the correct workspace/store context.
- Generate key and reveal secret exactly once.
- Use quickstart sample to connect the external website.