Getting Started
Integrate Vespid's financial literacy platform into your application.
Integration Methods
| Method | Description | Best For |
|---|---|---|
| Browser | Link users to Vespid web app | Quick setup, mobile browsers |
| Embedded | WebView/iframe in your app | Seamless in-app experience |
Authentication Modes
| Auth Mode | Description | Requires API Key |
|---|---|---|
| Native | Users login/register on Vespid | No |
| API | Your backend authenticates users | Yes |
Compatibility
| Integration | Native Auth | API Auth |
|---|---|---|
| Browser | ✅ | ❌ |
| Embedded | ✅ | ✅ |
Quick Start
Browser + Native Auth (Simplest)
Link users to Vespid with your partner param:
https://integration.vespid.my?partner=<partner_registration_code>
Embedded + API Auth (Seamless)
- Your backend calls SSO API
- Pass token to WebView
- Users are automatically logged in
Prerequisites
| Requirement | Native Auth | API Auth |
|---|---|---|
| Partner registration param | ✅ | ✅ |
| API Key from Vespid | ❌ | ✅ |
Environments
Vespid provides two environments for partner integration.
| Environment | Web App | API Base | API Key Prefix |
|---|---|---|---|
| Staging | https://staging-integration.vespid.my | https://api-staging.vespid.my | vspd_test_* |
| Production | https://integration.vespid.my | https://api.vespid.my | vspd_live_* |
tip
All code examples in these docs use production URLs for clarity. When integrating, point your implementation at the staging URLs first and only switch to production after your integration is verified.
Onboarding Flow
Vespid follows a staging-first onboarding model. Production access is granted only after your integration is verified on staging.
- Receive staging credentials. Your Vespid account manager issues a staging Partner Registration Code and (for API Auth) a staging API key (
vspd_test_*). - Build against staging. Implement your integration using the staging URLs from the Environments table.
- Self-test. Verify the full user flow (login/SSO, partner association, learning experience) end-to-end on staging using synthetic test users.
- Joint review. Walk through the integration with your Vespid account manager. We confirm requests are arriving correctly and your partner association is recorded.
- Receive production credentials. After sign-off, you'll be issued a production Partner Registration Code and API key (
vspd_live_*). - Production smoke test. Swap the staging URLs and credentials for production and run one or two calls against a designated test account before exposing the integration to real users.
- Go live.
Staging guardrails
Staging data is non-production and may be reset without notice. Always use synthetic test users — never real customer emails — while integrating. Staging is rate-limited; contact us before running load tests.
Next Steps
- Browser Integration - Link to Vespid web app
- Embedded Integration - WebView/iframe in your app