# Developer Platform, Sandbox & Key Management

> Registration, API credentials, webhooks, SSE, sandbox certification, deterministic test tools, and settings.

Product 8 in the [Partner API product catalog](/partners/docs/api-products), covering **42 operations**.

Registration, API credentials, webhooks, SSE, sandbox certification, deterministic test tools, and settings.

## Integration guides

[auth](/partners/docs/auth) · [key management](/partners/docs/key-management) · [paper demo trading](/partners/docs/paper-demo-trading) · [webhooks](/partners/docs/webhooks) · [sse events](/partners/docs/sse-events)

## Endpoint catalog

Paths are relative to `https://mystocks.africa/api/v1/partner` in production and `https://mystocks.africa/api/sandbox/v1/partner` in sandbox.

Open the [API Reference](/partners/docs/api-reference) and search the operation ID for request parameters, schemas, response codes, and examples. Use the [API Tester](/partners/docs/api-tester) to exercise an operation.

Sandbox availability is taken from each operation's OpenAPI metadata. Production-only operations and unsupported sandbox stubs are explicitly distinguished; account entitlements and instrument eligibility still apply.

| Method and path                      | Operation ID                  | Purpose                                                   | Sandbox          |
| ------------------------------------ | ----------------------------- | --------------------------------------------------------- | ---------------- |
| `GET /account`                       | `listAccount`                 | Get partner account                                       | Available        |
| `DELETE /api-keys/data-key`          | `deleteDataKey`               | Revoke data API key                                       | Unsupported stub |
| `GET /api-keys/data-key`             | `listDataKey`                 | Get data API key                                          | Available        |
| `POST /api-keys/data-key`            | `createDataKey`               | Issue data API key                                        | Unsupported stub |
| `DELETE /api-keys/revoke`            | `deleteSandboxKeyRevokeAlias` | Sandbox key-revocation alias (unsupported) **Deprecated** | Unsupported stub |
| `POST /api-keys/revoke`              | `createRevoke`                | Revoke API key                                            | Unsupported stub |
| `POST /api-keys/rotate`              | `createRotate`                | Rotate API key                                            | Available        |
| `POST /apply`                        | `submitPartnerApplication`    | Submit partner application                                | Production only  |
| `GET /certification`                 | `getCertification`            | Get certification checklist                               | Production only  |
| `PATCH /certification`               | `updateCertification`         | Update certification evidence                             | Production only  |
| `POST /certification`                | `requestGoLiveReview`         | Request go-live review                                    | Production only  |
| `GET /installations`                 | `listPartnerInstallations`    | List this partner's OnPrem installation status            | Production only  |
| `GET /me`                            | `listMe`                      | My status and workspace access                            | Available        |
| `POST /me`                           | `updatePartnerWorkspace`      | Select a portal environment or save deployment preference | Production only  |
| `GET /notification-rules`            | `getNotificationRules`        | Get notification policy                                   | Production only  |
| `PUT /notification-rules`            | `replaceNotificationRules`    | Replace notification policy                               | Production only  |
| `GET /openapi.json`                  | `getPartnerOpenApiJson`       | Download partner OpenAPI JSON                             | Production only  |
| `GET /openapi.yaml`                  | `getPartnerOpenApiYaml`       | Download partner OpenAPI YAML                             | Production only  |
| `GET /pricing`                       | `getPricing`                  | Get partner markup pricing                                | Available        |
| `PATCH /pricing`                     | `updatePricing`               | Update partner markup pricing                             | Available        |
| `GET /public-brand`                  | `getPublicPartnerBrand`       | Resolve public partner branding                           | Production only  |
| `POST /register`                     | `createRegister`              | Register sandbox account                                  | Available        |
| `POST /reset`                        | `createReset`                 | Reset sandbox account                                     | Available        |
| `POST /sandbox/deposit`              | `createSandboxDeposit`        | Credit virtual funds (deprecated alias) **Deprecated**    | Available        |
| `GET /sandbox/orders`                | `listSandboxOrders`           | List test orders (deprecated alias) **Deprecated**        | Available        |
| `POST /sandbox/trade`                | `createSandboxTrade`          | Submit test trade (deprecated alias) **Deprecated**       | Available        |
| `POST /session`                      | `createPartnerSession`        | Mint a portal session token                               | Production only  |
| `GET /settings`                      | `listSettings`                | Get settings                                              | Available        |
| `PATCH /settings`                    | `updateSettings`              | Update settings                                           | Available        |
| `POST /settings`                     | `createSettings`              | Test SMTP                                                 | Available        |
| `POST /test-tools/deposit`           | `createTestToolsDeposit`      | Credit virtual funds                                      | Available        |
| `GET /test-tools/orders`             | `listTestToolsOrders`         | List test orders                                          | Available        |
| `PATCH /test-tools/orders/{orderId}` | `updateTestToolsOrder`        | Advance a sandbox test order                              | Available        |
| `POST /test-tools/trade`             | `createTestToolsTrade`        | Submit test trade                                         | Available        |
| `GET /upgrade-request`               | `getUpgradeRequest`           | Check upgrade request status                              | Available        |
| `POST /upgrade-request`              | `createUpgradeRequest`        | Submit upgrade request                                    | Available        |
| `GET /webhooks`                      | `listWebhooks`                | List webhooks                                             | Available        |
| `POST /webhooks`                     | `createWebhooks`              | Register webhook                                          | Available        |
| `DELETE /webhooks/{id}`              | `deleteWebhooks`              | Delete webhook                                            | Available        |
| `GET /webhooks/{id}`                 | `getSandboxWebhook`           | Get sandbox webhook                                       | Available        |
| `GET /webhooks/{id}/deliveries`      | `listDeliveries`              | Webhook deliveries                                        | Available        |
| `POST /webhooks/{id}/test`           | `createTest`                  | Test webhook                                              | Available        |

## Shared contracts

[deployment options](/partners/docs/deployment-options) · [partner workspace](/partners/docs/partner-workspace) · [auth](/partners/docs/auth) · [errors](/partners/docs/errors) · [rate limits](/partners/docs/rate-limits) · [contract guarantees](/partners/docs/contract-guarantees)

[Download the September 2026 specification PDF](/docs/PartnerAPI.pdf). Read the [online clarifications](/partners/docs/partner-specification) before using the PDF's general examples.
