smartObjx API Documentation
Everything you need to integrate smartObjx cloud infrastructure into your application. REST APIs, SDK packages, sandbox access, and code examples.
Quick Start
- Get your API keys — every request requires two headers:
Ocp-Apim-Subscription-Key(your subscriber token) andOcp-Apim-POV-Key(your data owner token). See Authentication. - Try the sandbox — use the shared demo tokens below to explore without signing up. All three products share the same sandbox.
- Choose a product — pick the API reference for what you need: smartRules, smartSettings, or smartStructures.
- Install the SDK — use smartConnectors NuGet or npm packages for type-safe integration.
Sandbox Credentials
These shared demo tokens work immediately — no signup required.
| Header / Token | Value | POV |
|---|---|---|
Ocp-Apim-Subscription-Key | fd8efd80-f215-4c73-95f2-23841e98acbd | N/A |
Ocp-Apim-POV-Key | 45ef2936-160e-47dc-bd17-3dc0060acec9 | SaaS Publisher POV (top level) |
Ocp-Apim-POV-Key | 25ef2936-160e-47dc-bd17-3dc0060acec9 | Client POV (publisher's customer) |
Ocp-Apim-POV-Key | 05ef2936-160e-47dc-bd17-3dc0060acec9 | Customer POV (client's customer) |
Sandbox API URLs
| Product | Sandbox API Base URL | Browser IDE |
|---|---|---|
| smartRules | https://api.dev.smartobjx.com/rules-demo |
rules-demo.smartobjx.com |
| smartSettings | https://api.dev.smartobjx.com/settings-demo |
settings-demo.smartobjx.com |
| smartStructures | https://api.dev.smartobjx.com/structures-demo |
structures-demo.smartobjx.com |
API References
smartRules API
Business rules engine. Create use cases, build rulesets, evaluate rules against factbases, and parse human-readable expressions.
smartSettings API
Configuration management. Create applications, manage nested configurations, settings with encryption and versioning, and distribution analytics.
smartStructures API
Organizational hierarchies. Create perspectives, manage organizations in parent-child trees, and support multiple hierarchy views.
smartConnectors SDK
NuGet and npm packages. Type-safe domain classes for .NET and JavaScript — RulesApi, SettingsApi, StructuresApi, and more.
Common Patterns
All APIs use the same authentication
Every request to any smartObjx API requires the same two HTTP headers. See Authentication for the full explanation of the Subscriber → Client → Customer hierarchy.
All APIs return JSON
Request and response bodies are JSON. Set Content-Type: application/json for POST requests. Response objects include $id and $type fields for polymorphic serialization, plus OID (the unique object identifier), SubscriberID, OwnerID, and Version.
Object identity
Every object in smartObjx has an OID (a GUID) that uniquely identifies it. Use the OID to retrieve, update, or reference objects across API calls.
Multi-tenant data isolation
The Ocp-Apim-POV-Key header determines which data you see. Different POV keys show different data — this is how smartObjx enforces tenant isolation without separate databases.
Versioning
Rules, settings, and structures support versioning with start dates. Create a new version and set a future start date — the change becomes active automatically without a deployment.