.png)
Unleashed Software Integration Guide
Integrate Unleashed Software with enterprise systems through its signed REST API, paginated resource retrieval, and Martini workflows for synchronization and orchestration.
Unleashed Software integration options at a glance
Unleashed Software provides a documented HTTPS REST API for Products, Customers, Suppliers, Sales Orders, Purchase Orders, Warehouses, and inventory-related resources. Requests use an API ID, API key, and HMAC-based request signature, while collection responses are retrieved through pagination. Broad webhook coverage, bulk or asynchronous APIs, GraphQL, SOAP, file APIs, and direct database access were not confirmed. Martini can consume the REST API in scheduled workflows, maintain pagination checkpoints, map and validate data, apply business rules, and expose normalized APIs to downstream applications. Polling is the preferred synchronization approach where event delivery is unavailable or limited.
Common Unleashed Software integration patterns
Common Unleashed Software data objects used in integrations
Authentication and security considerations
Signed API authentication
Unleashed Software uses an API ID, API key, and HMAC-based request signature rather than a confirmed OAuth 2.0 flow. API calls should use HTTPS and remain subject to the permissions and subscription configuration of the Unleashed account.
Martini protection
Store the API ID and API key in protected Martini configuration or secrets. Keep signing logic reusable and separate from business mappings, and restrict access to integration assets according to the deployment environment.
- Do not embed API keys in workflow payloads or source-controlled definitions.
- Validate authentication failures separately from authorization and data-validation failures.
- Review credential rotation and tenant permission procedures with the Unleashed administrator.
Operational considerations for Unleashed Software integrations
Pagination and rate control
Process collection endpoints page by page using the documented parameters. Control concurrency and account for quotas, throttling, and transient HTTP failures with appropriate retry and backoff policies.
Idempotency and reconciliation
Use stable identifiers such as order numbers, Product codes, customer numbers, supplier codes, and purchase-order numbers. Persist checkpoints and compare key totals or object counts so failed or partial runs can be reconciled.
Mapping and inventory semantics
Explicitly map product codes, warehouses, units of measure, tax codes, currencies, and customer or supplier identifiers. Define whether the target receives total Stock On Hand, warehouse-specific quantities, or a calculated available-to-sell value.
Change management
Treat API responses as integration contracts. Validate required fields, tolerate nonessential additions where appropriate, and test changes to resource fields, pagination behavior, authentication requirements, and error formats before production deployment.
Why use Martini instead of scripts or point-to-point integrations?
Centralized orchestration
Martini coordinates extraction from Unleashed, transformation, validation, target writes, retries, and reconciliation in workflows rather than scattering logic across independent scripts.
Reusable integration assets
Teams can separate authentication, pagination, mapping, business rules, and delivery into maintainable workflow components and expose normalized APIs to downstream applications when appropriate.
Operational control
- Use protected configuration for signed API credentials.
- Maintain checkpoints for scheduled synchronization and recovery.
- Route validation failures separately from transient API failures.
- Monitor workflow execution and retain identifiers needed for replay.
This approach reduces duplicated point-to-point logic while preserving the flexibility to implement Unleashed-specific mappings and request-signing behavior.