Scanning Solution Integration Guide
Step-by-step instructions for creating orders in the Toolkit3D platform
Overview
This guide provides step-by-step instructions on how to create orders in the Toolkit3D order management system. T3D Platform offers multiple ways of integration that can be customized to the partner's needs.
When integrating for order creation you will need to work with two modules of our Platform:
Order Management System
Handle order information and mapping
Assets Management
Handle scan data or data references
All our modules come with OpenAPI specs that can be used to generate API clients using OpenAPI Generator. View our Commercial API documentation.
Integration Scenarios
We support multiple integration approaches to fit your specific needs:
T3D Assets Management + Client Credentials
The scanning application authenticates with client credentials (assigned to partner or organization) and uploads scan data directly to Toolkit3D systems.
Flow:
- 1.Login with client ID and client secret → receive bearer token
- 2.Request upload URL from T3D
- 3.Upload scan file to the provided URL
- 4.Create order with scan file reference, product parameters, and shipping details
3rd Party Auth + 3rd Party Data Source
Scanning application uses its own authentication token from partner's auth server. No scan data is uploaded to T3D - only references to files in partner's system.
Flow:
- 1.Create order with scan file reference and product details using 3rd party token
- 2.T3D fetches scan data during processing using agreed authentication method
Requirements: Technical deep-dive to establish trust, identity validation, and JWKS for JWT tokens. T3D team needs to understand partner's authentication and data access patterns.
Custom Mixed Scenarios
Any combination of the above scenarios is possible. We work with partners to create solutions that fit their specific technical requirements and business needs.
Implementation Steps
Follow these steps to integrate your scanning solution with the Toolkit3D platform:
Authentication
Authenticate with the Toolkit3D platform to receive an access token.
POST /oauth/token
Development: https://api.dev.toolkit3d.com/oauth/token
Production: https://api.prod.toolkit3d.com/oauth/token
Request Headers:
Content-Type: application/x-www-form-urlencodedAuthorization: Basic [credentials]
Request Body:
grant_type=client_credentials
File Upload
Request a pre-signed upload URL and upload your scan data.
POST /v1/asset/upload
Development: https://api.dev.toolkit3d.com/v1/asset/upload
Production: https://api.prod.toolkit3d.com/v1/asset/upload
Request Body:
Response:
- ref: Reference to use when creating order
- url: Pre-signed S3 URL for PUT upload
Order Creation
Create an order with product details, scan references, and shipping information.
POST /v1/orders
Development: https://api.dev.toolkit3d.com/v1/orders
Production: https://api.prod.toolkit3d.com/v1/orders
Key Fields:
- orderNumber: Your custom order identifier
- siteId: Store/facility UUID or custom identifier
- items: Product IDs and variant attributes
- biometrics: Scan file references and body part data
- shipment: Delivery address and type (home/store)
Glossary
Partner
Company integrating with Toolkit3D Platform
Solution
The software that will create orders in T3D Platform
Scanning Kiosk
Application used to scan people and create orders
T3D Platform
Toolkit3D order management and asset management system
Ready to integrate?
Our team will work with you to customize the integration to your specific needs. Contact us to discuss your requirements and get started.