Integration

Configurator API

Secure server-to-server access to company statistics, diagnostics and activity in Configurator Studio v509.

Connection status

Tests GET /api/platform/companies with the dedicated API key.

Not checked
Platform PortalBilling + owner interface
X-Platform-Api-Key
Configurator AdminPortalhttp://127.0.0.1:6301
Base URLhttp://127.0.0.1:6301
HeaderX-Platform-Api-Key
API key9e8d••••••••0f01
Page size200
Required Configurator settings

Use environment variables in production.

PlatformPortalApi__Enabled=true
PlatformPortalApi__ApiKey=<minimum-32-character-secret>
PlatformPortalApi__HeaderName=X-Platform-Api-Key
Platform Portal must use the same secret in ConfiguratorApi__ApiKey. The secret is never sent to the browser.
Connected endpoints

Company, access-management and backup contracts match ConfiguratorStudio v509.

16 secured endpoints
GET
/api/platform/companies Company list and high-level counts
GET
/api/platform/companies/{tenantId} Company identity and plan
GET
/api/platform/companies/{tenantId}/statistics Projects, models, catalog, pricing, quotes and users
GET
/api/platform/companies/{tenantId}/health Critical and warning health summary
GET
/api/platform/companies/{tenantId}/projects Projects and publication readiness
GET
/api/platform/companies/{tenantId}/models Model files, analysis and geometry
GET
/api/platform/companies/{tenantId}/users Accounts, roles and 30-day login counts
GET
/api/platform/companies/{tenantId}/login-activity Successful and failed login audits
GET
/api/platform/companies/{tenantId}/errors Detected operational problems
GET
/api/platform/companies/{tenantId}/recent-activity Recent audit activity
POST
/api/platform/companies/provision Create a paid customer tenant and first administrator
POST
/api/platform/companies/{tenantId}/access Activate, suspend or archive company access
GET
/api/platform/backups/status Configurator backup schedule and latest result
GET
/api/platform/backups Configurator backup history
POST
/api/platform/backups/run Run a Configurator database and model-storage backup
POST
/api/platform/backups/{backupId}/verify Verify a stored Configurator backup archive