Data Integration

In Development

Seamless data flow between systems and formats. Currently providing API-based data access with plans for comprehensive integration capabilities.

Implementation Status

API Data Access
Implemented
Complete REST API for accessing machine data, tags, and system information.
Machine registry endpoints
Tag management and read/write
Semantic tag operations
JSON data format
Document Management
Foundation Ready
Document storage and retrieval system with metadata management.
Document upload/download
Metadata storage
Content type management
Search and indexing (planned)
Protocol Connectors
Planned
Industrial protocol support for direct equipment communication.
OPC UA client/server
Modbus TCP/RTU
Ethernet/IP
MQTT broker integration
Real-time Streaming
Planned
Live data streaming and event-driven integration patterns.
WebSocket streaming
Event-driven updates
Change detection
Subscription management

Current Integration Capabilities

Machine Data Integration
Access and manipulate machine data through our REST API
# Get all machines in your facility
curl https://sapienstream.com/api/machines \
  -H "Authorization: Bearer your_jwt_token"

# Response includes machine registry
[
  {
    "id": "machine_001",
    "name": "Injection Molding Press 1",
    "type": "INJECTION_MOLDING",
    "location": "Production Floor A",
    "status": "RUNNING",
    "last_updated": "2024-01-15T10:30:00Z",
    "tags_count": 45
  }
]

# Get specific machine with all tags
curl https://sapienstream.com/api/machines/machine_001/tags \
  -H "Authorization: Bearer your_jwt_token"

# Write data to a tag
curl -X POST https://sapienstream.com/api/machines/machine_001/tags/temperature/write \
  -H "Authorization: Bearer your_jwt_token" \
  -H "Content-Type: application/json" \
  -d '{
    "value": 185.5,
    "quality": "GOOD",
    "timestamp": "2024-01-15T10:30:00Z"
  }'
Document Integration
Upload and manage manufacturing documents and specifications
# Upload a document
curl -X POST https://sapienstream.com/api/documents/upload \
  -H "Authorization: Bearer your_jwt_token" \
  -F "file=@process_specification.pdf" \
  -F "metadata={
    "title": "Process Specification Rev 2.1",
    "category": "PROCESS_SPEC",
    "tags": ["injection_molding", "quality_control"]
  }"

# List documents with filtering
curl https://sapienstream.com/api/documents?category=PROCESS_SPEC \
  -H "Authorization: Bearer your_jwt_token"

# Download a document
curl https://sapienstream.com/api/documents/doc_123/download \
  -H "Authorization: Bearer your_jwt_token" \
  -o downloaded_document.pdf

Planned Integration Features

Data Format Support
Planned
Support for multiple data formats and transformation capabilities.
CSV import/export
Excel spreadsheet integration
XML data exchange
Parquet for analytics
Data validation schemas
ETL Pipelines
Planned
Extract, Transform, Load operations for data warehouse integration.
Scheduled data extraction
Data transformation rules
Quality checks and validation
Error handling and retry logic
Pipeline monitoring
Bulk Operations
Planned
Efficient handling of large-scale data operations and migrations.
Bulk tag data import
Historical data migration
Batch processing jobs
Progress tracking
Rollback capabilities
External System Connectors
Planned
Pre-built connectors for common industrial and enterprise systems.
ERP system integration
MES connectivity
Historian data sources
Cloud platform bridges
Database synchronization

Development Roadmap

Integration Development Plan
Our planned approach to expanding data integration capabilities

Phase 1: Protocol Foundation (Foundation)

Establish core industrial protocol support for direct equipment communication.

• OPC UA client implementation
• Modbus TCP driver
• MQTT pub/sub integration
• Basic real-time data streaming

Phase 2: Data Transformation (Next)

Build comprehensive ETL capabilities and format support.

• CSV/Excel import tools
• Data validation framework
• Transformation rule engine
• Bulk operation support

Phase 3: Enterprise Integration (Future)

Connect with existing enterprise systems and data warehouses.

• ERP system connectors
• Database synchronization
• Cloud platform bridges
• Advanced analytics integration

Phase 4: Advanced Features (Advanced)

Intelligent automation and self-managing data pipelines.

• Auto-discovery protocols
• ML-driven data quality
• Self-healing pipelines
• Predictive integration monitoring

Available Today

While we work on expanding integration capabilities, you can already:

Access all data through our REST API
Upload and manage manufacturing documents
Build custom integrations using our API
Export data in JSON format for analysis