For Developers
Build personalized product workflows on Toolkit3D.
Use Toolkit3D APIs to connect scans, product catalogs, custom order creation, design automation, manufacturing files, and fulfillment status into your own application or existing operations stack.
Start with a Toolkit3D account, generate API credentials, and create your first order against a configured product catalog.
Your first integration path
The fastest way to understand Toolkit3D is to create an order for a product that already exists in your account. The quickstart assumes access to a trial or onboarding account with demo products, stores, and API credentials already configured.
Start a trial or request onboarding
Use the self-service Toolkit3D trial to get a workspace with a sample catalog and the organization structure needed to test order creation. If your integration involves multiple organizations, external storage, or manufacturing partners, book technical onboarding instead.
Generate API credentials
Create a client application in the Dashboard and use client credentials to request an access token. Credentials may be scoped to an organization, store, or manufacturing site depending on the integration.
Read available products and requirements
Use the product and inventory data available to your account to understand what can be sold, which product identifiers to use, and which scans, files, or parameters are required.
Upload or reference files, then create an order
Upload scan data through the Assets API or provide references to files in your own storage. Create an order with product identifiers, selected variant attributes, biometric references, and shipping or store delivery information.
The core API flow
Most integrations start with the same loop: discover what can be ordered, provide the files and parameters needed to personalize it, then create an order that Toolkit3D can route through design and manufacturing.
Authenticate
Request an access token using client credentials. The token carries organization, account type, role, and optional site context that determine which resources the API returns.
Discover products
Use product, variant, and inventory data to build your product page or order form. Products define commercial information, technical workflow requirements, and dependencies such as scan type, body part, or custom attributes.
Prepare assets
Upload files into Toolkit3D storage with a pre-signed URL, or pass a reference to a connected external data source. Asset references are passed into orders and resolved only when needed.
Create the order
Submit your order number, site or store identifier, product identifiers, variant attributes, biometric references, and delivery details. Toolkit3D resolves mappings and routes the order into the configured workflow.
Track progress
Use order APIs and webhooks to follow status changes through accepted, design, manufacturing, shipping, and completion states.
Quickstart preview
The full request and response schemas live in the API reference. This preview shows the shape of the first integration.
Request an access token
curl --request POST 'https://api.dev.toolkit3d.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <client-id-and-secret>' \
--data-urlencode 'grant_type=client_credentials'Get an upload URL
curl --request POST 'https://api.dev.toolkit3d.com/v1/asset/upload' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "scan-head.obj",
"bucket": "BIOMETRICS"
}'Create an order
{
"orderNumber": "your-order-id",
"siteId": "your-store-or-site-identifier",
"items": [
{
"productId": "your-product-identifier",
"quantity": 1,
"selectedVariant": {
"productVariantAttributes": [
{ "name": "Size", "value": "Large" },
{ "name": "Color", "value": "black" }
]
}
}
],
"biometrics": {
"scans": [
{
"scanFile": {
"ref": "biometrics://.../scan-head.obj",
"name": "scan-head.obj"
},
"scanType": { "main": "3dScan", "secondary": "normal" },
"bodyPart": { "slot": "head" }
}
]
}
}Concepts that shape every integration
Toolkit3D is a multi-sided platform. A retailer, brand, manufacturer, support team, or tenant may interact with the same order through different permissions and different data views.
Organizations and sites
Companies, stores, clinics, labs, and manufacturing locations are modeled as organizations and sites. Your integration can be scoped to the whole organization or to a specific location.
Account types
Retailers capture customers, scans, and orders. Brands define products and distribution. Manufacturers receive the files and order data required for production. Tenants oversee linked retailers. Support teams help configure and operate customer workspaces.
Roles and permissions
Roles define what a user or client can do. Account type defines which data that user or client can see. For example, a retailer can access customer data it captured, while a manufacturer receives only the data required to produce assigned items.
Product dependencies
A product can require scans, profile fields, attachments, selected attributes, or other inputs. Your app should read product requirements before constructing the order form.
File references
Orders store file references, not always direct file URLs. Use the Assets API to upload, download, or resolve files from Toolkit3D storage or approved external sources.
Workflows and statuses
Once an order is accepted, Toolkit3D routes it through design engines, adapters, manufacturing systems, and status updates based on the product workflow.
Choose the integration pattern that fits your system
Toolkit3D-hosted assets + client credentials
Best when your app can upload scans or files directly to Toolkit3D. Request a pre-signed upload URL, upload the file, then create the order with the returned file reference.
External storage + trusted source integration
Best when files must remain in your own cloud. Your order sends Toolkit3D a file reference and source identifier; Toolkit3D fetches or streams the file when the configured workflow needs it.
Platform-to-platform automation
Best when your OMS, ERP, MES, print farm, or design engine already manages part of the lifecycle. Toolkit3D can push orders, expose pull endpoints, receive status updates, or fire webhooks on workflow changes.
Map your business model before you integrate
Most successful integrations start by mapping how your business already operates. The account structure determines inventory access, order visibility, customer data access, and manufacturing routing.
Bring these answers to technical onboarding and Toolkit3D can configure organizations, credentials, product mappings, and workflows to match your operational model.
Who captures the customer, scan, or prescription data?
Who owns the product catalog and decides which stores can sell which products?
Does each user work in one store, many stores, or across a whole enterprise?
Who designs the product: your team, Toolkit3D, a third-party design engine, or the manufacturer?
Where do files live: Toolkit3D storage, your cloud, scanner vendor storage, or a manufacturing partner?
Who needs status updates, and should they receive them through APIs, webhooks, or Dashboard views?
Ready to build your first workflow?
Start a Toolkit3D trial to explore the platform with a configured workspace, review the API reference, or schedule technical onboarding when your account structure, product mappings, or file sources need to be designed with the Toolkit3D team.
Commercial API Reference
Review the current OpenAPI reference for Toolkit3D commercial APIs.
View PageScanning Solution Integration
Follow the step-by-step guide for creating orders through the API.
View PageCustom API Integration
See how Toolkit3D connects scanners, CAD, printers, ERPs, and portals.
View Page