On-prem deployment
Plan your MyStocks partner installation, request access and follow the deployment and operations journey.
For Hosted API/OnPrem/Both choices, separate approvals and credential lifecycles, start with Deployment options and Partner workspace.
What runs on your infrastructure?
The on-prem image hosts the partner workspace and a restricted HTTP proxy on your own HTTPS domain. MyStocks Cloud remains authoritative for trading, balances, membership, permissions and licensing. An active cloud connection is required: this is not an offline exchange.
Reviewed October 6, 2026. Use the approved release digest and installation instructions supplied for your organization.
Start here
- Request onboarding and access. Start a 14-day self-service evaluation with a verified account, or request administrator review for Enterprise access and unsupported topologies.
- Prepare and install: host, registry, domain, TLS and installer options.
- Activate and manage keys: verification, expiry, renewal and revocation.
- Connect applications: sign-in, API credentials, sandbox and proxy behavior.
- Operate and troubleshoot: readiness, upgrades, rollback and support.
Hosted versus on-prem responsibilities
| Responsibility | MyStocks-hosted workspace | On-prem workspace |
|---|---|---|
| Workspace hosting and TLS | MyStocks | Your infrastructure team |
| Server patches, backups and monitoring | MyStocks | Your infrastructure team |
| Local proxy, DNS and release upgrades | MyStocks | Your infrastructure team |
| API authorization, trading and balances | MyStocks Cloud | MyStocks Cloud |
| Team permissions and identity policies | Authorized organization administrators | Authorized organization administrators |
| Installation license and domain approval | Not an on-prem requirement | Self-service evaluation policy; administrator approves production; your team installs securely |
What does the license include?
Evaluation approval permits hosted sandbox exploration without DNS. Self-hosted evaluation uses a temporary identity-bound license. Production requires separate domain verification, commercial entitlement and explicit administrator confirmation. A license permits the installation to connect. It does not expand your API entitlements, supported markets, permissions or sandbox capabilities. Self-service evaluation lasts 14 days with one installation identity. Repeat evaluations and extensions require administrator review; reviewed evaluations have an administrator-set expiry. Permanent activation has no scheduled expiry but remains revocable. Pricing, scope and service terms are agreed with sales; this guide makes no additional availability or latency guarantee.
Can we operate without cloud connectivity?
No. Readiness and protected API access fail closed when license verification cannot reach MyStocks. Public pages may still load while the installation is not ready. Plan monitoring and recovery around both local infrastructure and the cloud dependency.
Public addresses
The public documentation home is partners.mystocks.africa/partners/docs. Cloud production API calls continue to use https://mystocks.africa/api/v1/partner; moving documentation does not change API endpoints.
For agents, use the documentation catalog, plain-text source, and OpenAPI contract. Never include credentials in prompts, examples or support tickets.
Can I choose Hosted API, OnPrem or both?
Yes. Select Hosted API, OnPrem or Both when applying. Your connection preference does not grant an entitlement. One partner account shows API access and Installations & licenses as separate sections on the dashboard overview. You can change your personal connection preference there.
The Sandbox / Live selector checks access on the server. Hosted Live approval and an OnPrem production activation are separate decisions. An OnPrem evaluation remains Sandbox-only even if the same organization has Hosted Live approval. Conversely, a separately approved Hosted Live service is not disabled merely because an installation license expires. Existing accounts retain their previous access policy until partner operations makes an explicit Hosted Live decision.
| Credential | Purpose | Lifecycle |
|---|---|---|
| Sandbox API key | Synthetic calls in /api/sandbox/v1/; quotes delayed by 15 minutes | Created and rotated in the Sandbox console; cannot authorize Live calls |
| Production API key | Approved Live API calls in /api/v1/partner/ | Issued/rotated for the organization, independently suspendable and revocable; API scopes and commercial entitlements still apply |
| Installation license credential | Authorizes a particular gateway, installation identity and domain | Self-service evaluation for 14 days, reviewed temporary access with an admin-set expiry, or permanent and revocable production; retrieval, renewal, domain verification and installation proof are separate from API approval |
Partner operations uses Access & deployments in /admin/partners/{partnerId} to review Hosted Live approval independently from domain verification, installation status, license expiry and the next required action. An approval or block requires an authorized administrator, a review reason, explicit confirmation and recent sign-in. It records audit evidence and queues a customer notification. Installation production activation retains its own DNS, identity and commercial checks.
Was this page useful?
Your signal helps us tighten partner onboarding docs.
Last updated on