API PLATFORM
A controlled interface to Hamiltonn platform services.
Hamiltonn APIs expose supported product capabilities through documented interfaces instead of direct production-database access.
Hamiltonn Cloud
A controlled interface to Hamiltonn platform services.
The Hamiltonn Cloud API platform is the external interface through which supported customer applications and backend systems interact with Hamiltonn platform services.
Definition
What does this mean?
The Hamiltonn Cloud API platform is the external interface through which supported customer applications and backend systems interact with Hamiltonn platform services.
Hamiltonn Cloud combines reusable software infrastructure, configurable product capabilities and flexible deployment so organisations can build around their own brand and operating model.
DESIGN
Predictable resource-oriented interfaces.
Resources
Clear nouns for customers, projects, wallets and domain objects.
HTTP semantics
Standard methods and status codes.
JSON contracts
Documented request and response structures.
Request identifiers
Traceable integration behaviour for support.
RELIABILITY
Design integrations for retries and growth.
Idempotency
Protect retry-sensitive actions from duplicate execution.
Pagination
Keep collection responses bounded.
Filtering
Query relevant subsets.
Rate controls
Protect services from accidental or abusive traffic.
CHANGE
Public APIs need a lifecycle.
- Do not build against undocumented internal endpoints.
- Use the documented version and environment.
- Follow deprecation and migration guidance when a supported API evolves.
PRODUCT FAMILIES
APIs follow Hamiltonn product domains.
SECURITY
APIs are security boundaries.
FAQs
API PLATFORM FAQs
Does Hamiltonn provide REST APIs?
Hamiltonn’s external developer model uses documented HTTP APIs for supported services.
Can I access the production database directly?
Not under the standard API model. Customer integrations use supported public interfaces.
How are breaking changes handled?
Breaking changes should follow explicit versioning or migration processes.
What is idempotency used for?
It helps prevent retry-sensitive requests from unintentionally creating duplicate actions.
Are all product capabilities exposed the same way?
No. The available API surface depends on the selected product and supported services.
Build on Hamiltonn Cloud.
Choose the product, modules and deployment model that fit your business, then bring the customer experience under your own brand.