Developer Documentation

Overview

Welcome to the Industry Software Developer Documentation. Our API allows you to integrate with our cloud-based platform for enterprise resource planning, customer relationship management, warehouse management, manufacturing execution, and quality management systems.

Core Modules

API Capabilities

Developer Tools

Quick Start

Get started with the Industry Software API in just a few steps:

1. Sign Up for a Developer Account

Create a developer account to obtain your API keys and access the sandbox environment.

2. Authentication

Authenticate your requests using OAuth 2.0. Obtain an access token to make API calls.

curl -X POST https://api.industrysoftware.com/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "grant_type": "client_credentials"}'

3. Make Your First API Call

Test your connection with a simple API call to get system information.

curl -X GET https://api.industrysoftware.com/v1/system/info \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

4. Explore the API

Start building with our comprehensive API documentation and examples.

What's Next?

• Review the Authentication section for detailed OAuth 2.0 information
• Check out the ERP Integration guide for financial operations
• Explore the CRM Integration for customer management
• Visit our Sandbox Environment to start testing

Authentication

The Industry Software API uses OAuth 2.0 for authentication. You'll need to obtain an access token before making API calls.

OAuth 2.0 Flow

• Register your application in the Developer Portal
• Obtain client ID and client secret
• Request an access token
• Include the access token in your API requests

Token Request

curl -X POST https://api.industrysoftware.com/v1/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

Token Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "scope": "api:read api:write"
}

Using the Token

curl -X GET https://api.industrysoftware.com/v1/erp/financial/reports \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Token Expiration

Access tokens expire after 24 hours. You'll need to refresh your token when it expires.

Best Practices

• Store your client credentials securely (use environment variables)
• Cache access tokens to minimize token requests
• Handle token expiration gracefully with retry logic
• Use HTTPS for all API requests

Rate Limits

To ensure fair usage and system stability, the Industry Software API has rate limits in place.

• Standard rate limit: 1000 requests per minute
• Enterprise plan: 5000 requests per minute
• Burst limit: 100 requests per second

When you approach the rate limit, you'll receive a 429 Too Many Requests response. We recommend implementing exponential backoff in your code to handle rate limiting.

Rate Limit Headers

Each API response includes headers that show your current rate limit status:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 2024-01-15T10:31:00Z

Handling Rate Limits

• Check headers: Monitor the rate limit headers in responses
• Exponential backoff: Implement retry logic with exponential backoff
• Bulk operations: Use batch endpoints when available
• Caching: Cache responses to reduce unnecessary API calls

Rate Limit Examples

curl -I https://api.industrysoftware.com/v1/erp/financial/reports \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Rate Limit Response

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 2024-01-15T10:31:00Z
Retry-After: 60

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please try again later.",
  "retry_after": 60
}

Best Practices

• Implement request queuing to smooth out API calls
• Use webhooks instead of polling for real-time updates
• Batch multiple operations into single requests
• Cache frequently accessed data

Nexus | ERP Integration

Integrate with our Enterprise Resource Planning system to automate financial operations, supply chain management, and human resources.

Key Endpoints

// Get financial reports
GET /api/v1/erp/financial/reports

// Create purchase order
POST /api/v1/erp/purchase-orders

// Get employee data
GET /api/v1/erp/hr/employees

Use Cases

• Financial system integration
• Supply chain optimization
• HR system synchronization

Sample Request

curl -X GET https://api.industrysoftware.com/v1/erp/financial/reports \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response Example

{
  "reports": [
    {
      "id": "FIN-001",
      "name": "Monthly Financial Statement",
      "type": "balance_sheet",
      "generated_at": "2024-01-15T10:30:00Z",
      "status": "completed"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total": 1
  }
}

Authentication Requirements

• OAuth 2.0 Bearer Token
• Scope: erp:read or erp:write
• Rate Limit: 100 requests/minute

Harmony | CRM Integration

Integrate with our Customer Relationship Management system to build lasting relationships and drive revenue growth.

Key Endpoints

// Get customer data
GET /api/v1/crm/customers

// Create sales opportunity
POST /api/v1/crm/opportunities

// Get marketing campaign results
GET /api/v1/crm/marketing/campaigns

Use Cases

• Customer data synchronization
• Sales pipeline integration
• Marketing automation

Sample Request

curl -X POST https://api.industrysoftware.com/v1/crm/customers \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "email": "contact@acme.com",
    "phone": "+1-555-0123",
    "industry": "Manufacturing"
  }'

Response Example

{
  "id": "CUST-001",
  "name": "Acme Corporation",
  "email": "contact@acme.com",
  "phone": "+1-555-0123",
  "industry": "Manufacturing",
  "created_at": "2024-01-15T10:30:00Z",
  "last_modified": "2024-01-15T10:30:00Z"
}

Best Practices

• Use webhooks for real-time customer updates
• Implement rate limiting in your application
• Cache customer data to reduce API calls
• Handle errors gracefully with proper retry logic

Hive | WMS Integration

Integrate with our Warehouse Management System to optimize warehouse operations with real-time inventory management.

Key Endpoints

// Get inventory levels
GET /api/v1/wms/inventory

// Create picking order
POST /api/v1/wms/picking-orders

// Get warehouse performance metrics
GET /api/v1/wms/performance

Use Cases

• E-commerce integration
• Inventory synchronization
• Order fulfillment optimization

Sample Request

curl -X POST https://api.industrysoftware.com/v1/wms/picking-orders \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-12345",
    "items": [
      {"sku": "PROD-001", "quantity": 2},
      {"sku": "PROD-002", "quantity": 1}
    ],
    "priority": "standard"
  }'

Response Example

{
  "picking_order_id": "PO-78901",
  "order_id": "ORD-12345",
  "status": "created",
  "assigned_warehouse": "WH-NYC-01",
  "estimated_completion": "2024-01-15T14:00:00Z",
  "items": [
    {"sku": "PROD-001", "quantity": 2, "status": "pending"},
    {"sku": "PROD-002", "quantity": 1, "status": "pending"}
  ]
}

Integration Tips

• Use batch operations for bulk inventory updates
• Implement real-time inventory tracking with webhooks
• Monitor warehouse performance metrics regularly
• Set up alerts for low stock levels

Pulse | MES Integration

Integrate with our Manufacturing Execution System to bridge the gap between planning and shop floor operations.

Key Endpoints

// Get production data
GET /api/v1/mes/production

// Create work order
POST /api/v1/mes/work-orders

// Get equipment status
GET /api/v1/mes/equipment

Use Cases

• Shop floor data collection
• Equipment monitoring
• Production scheduling

Sample Request

curl -X POST https://api.industrysoftware.com/v1/mes/work-orders \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "PROD-001",
    "quantity": 100,
    "start_date": "2024-01-16",
    "line_id": "LINE-A",
    "priority": "high"
  }'

Response Example

{
  "work_order_id": "WO-56789",
  "product_id": "PROD-001",
  "quantity": 100,
  "status": "active",
  "start_date": "2024-01-16",
  "line_id": "LINE-A",
  "priority": "high",
  "created_at": "2024-01-15T08:00:00Z",
  "progress": {
    "completed": 0,
    "in_progress": 0,
    "pending": 100
  }
}

Real-Time Data

• Use WebSocket for real-time production updates
• Monitor OEE (Overall Equipment Effectiveness)
• Track work-in-progress (WIP) inventory
• Get machine downtime alerts

Guardian | QMS Integration

Integrate with our Quality Management System to ensure product quality and regulatory compliance.

Key Endpoints

// Get quality inspection results
GET /api/v1/qms/inspections

// Create non-conformance report
POST /api/v1/qms/non-conformances

// Get CAPA status
GET /api/v1/qms/capa/{id}

Use Cases

• Automated inspection data collection
• Integration with testing equipment
• Regulatory compliance reporting

Sample Request

curl -X POST https://api.industrysoftware.com/v1/qms/non-conformances \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "PROD-001",
    "batch_id": "BATCH-2024-001",
    "description": "Dimensional deviation detected",
    "severity": "medium",
    "detected_by": "automated-inspection"
  }'

Response Example

{
  "non_conformance_id": "NC-2024-001",
  "product_id": "PROD-001",
  "batch_id": "BATCH-2024-001",
  "description": "Dimensional deviation detected",
  "severity": "medium",
  "status": "open",
  "created_at": "2024-01-15T09:30:00Z",
  "assigned_to": "quality-team",
  "investigation_required": true
}

Compliance Features

• 21 CFR Part 11 compliance support
• Automated audit trail
• Electronic signatures
• Regulatory reporting templates

Origin | PLM Integration

Integrate with our Product Lifecycle Management system to manage product data throughout its lifecycle.

Key Endpoints

// Get product structure
GET /api/v1/plm/products/{id}/structure

// Update BOM
PUT /api/v1/plm/boms/{id}

// Get engineering changes
GET /api/v1/plm/ecos

Use Cases

• CAD system integration
• Engineering change management
• Supplier collaboration

Sample Request

curl -X PUT https://api.industrysoftware.com/v1/plm/boms/BOM-001 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "PROD-001",
    "revision": "B",
    "items": [
      {"component_id": "COMP-001", "quantity": 2, "position": 1},
      {"component_id": "COMP-002", "quantity": 1, "position": 2}
    ],
    "approved": true
  }'

Response Example

{
  "bom_id": "BOM-001",
  "product_id": "PROD-001",
  "revision": "B",
  "status": "approved",
  "items": [
    {"component_id": "COMP-001", "quantity": 2, "position": 1, "status": "active"},
    {"component_id": "COMP-002", "quantity": 1, "position": 2, "status": "active"}
  ],
  "created_at": "2024-01-10T08:00:00Z",
  "approved_at": "2024-01-15T10:30:00Z",
  "approved_by": "engineer@example.com"
}

Version Control

• Full revision history tracking
• Branch and merge support
• Change request workflow
• Impact analysis tools

Vault | IMS Integration

Integrate with our Inventory Management System to optimize stock levels and visibility.

Key Endpoints

// Get inventory levels
GET /api/v1/ims/inventory

// Create inventory transaction
POST /api/v1/ims/transactions

// Get stock movements
GET /api/v1/ims/movements

Use Cases

• Multi-location inventory sync
• Real-time stock updates
• Inventory forecasting

Sample Request

curl -X POST https://api.industrysoftware.com/v1/ims/transactions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "PROD-001",
    "from_location": "WH-NYC-01",
    "to_location": "WH-LAX-01",
    "quantity": 50,
    "transaction_type": "transfer",
    "reference_id": "TRF-2024-001"
  }'

Response Example

{
  "transaction_id": "TXN-2024-001",
  "sku": "PROD-001",
  "from_location": "WH-NYC-01",
  "to_location": "WH-LAX-01",
  "quantity": 50,
  "transaction_type": "transfer",
  "status": "completed",
  "created_at": "2024-01-15T11:00:00Z",
  "updated_at": "2024-01-15T14:30:00Z",
  "new_balance": {
    "wh_nyc_01": 150,
    "wh_lax_01": 75
  }
}

Inventory Features

• Real-time stock tracking across multiple locations
• Automated stock replenishment
• Serial and batch number traceability
• Inventory aging analysis

Blueprint | MRP Integration

Integrate with our Material Requirements Planning system to optimize production scheduling.

Key Endpoints

// Run MRP calculation
POST /api/v1/mrp/calculate

// Get production orders
GET /api/v1/mrp/production-orders

// Get material requirements
GET /api/v1/mrp/requirements

Use Cases

• Automated production scheduling
• Material planning optimization
• Capacity planning integration

Sample Request

curl -X POST https://api.industrysoftware.com/v1/mrp/calculate \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "planning_horizon": 30,
    "include_subcomponents": true,
    "safety_stock": true,
    "production_calendar": "standard"
  }'

Response Example

{
  "mrp_run_id": "MRP-2024-01-15-001",
  "status": "completed",
  "planning_horizon": 30,
  "generated_at": "2024-01-15T06:00:00Z",
  "results": {
    "production_orders": [
      {"product_id": "PROD-001", "quantity": 100, "start_date": "2024-01-20"}
    ],
    "purchase_orders": [
      {"component_id": "COMP-001", "quantity": 200, "supplier_id": "SUP-001"}
    ],
    "net_requirements": {
      "total_materials": 500,
      "shortages": 25,
      "excess": 15
    }
  }
}

Planning Features

• Automated material requirements calculation
• Capacity constraint optimization
• Multi-level BOM explosion
• What-if scenario analysis

Sentinel | AMP Integration

Integrate with our Asset Management Platform to monitor and maintain your assets.

Key Endpoints

// Get asset status
GET /api/v1/amp/assets/{id}/status

// Create maintenance work order
POST /api/v1/amp/work-orders

// Get maintenance history
GET /api/v1/amp/maintenance-history

Use Cases

• IoT device integration
• Predictive maintenance
• Asset lifecycle management

Sample Request

curl -X POST https://api.industrysoftware.com/v1/amp/work-orders \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "ASSET-001",
    "work_type": "preventive",
    "priority": "medium",
    "scheduled_date": "2024-01-20",
    "description": "Regular maintenance for CNC machine",
    "assigned_to": "maintenance-team-a"
  }'

Response Example

{
  "work_order_id": "WO-2024-001",
  "asset_id": "ASSET-001",
  "work_type": "preventive",
  "priority": "medium",
  "status": "scheduled",
  "scheduled_date": "2024-01-20",
  "description": "Regular maintenance for CNC machine",
  "assigned_to": "maintenance-team-a",
  "created_at": "2024-01-15T08:00:00Z",
  "estimated_duration": "4 hours",
  "estimated_cost": 500.00
}

Asset Monitoring

• Real-time asset health monitoring
• Predictive failure detection
• IoT sensor data integration
• Maintenance scheduling and tracking

Efficient | CPQ Integration

Integrate with our Configure, Price, Quote system to streamline your sales process.

Key Endpoints

// Configure product
POST /api/v1/cpq/configure

// Generate quote
POST /api/v1/cpq/quotes

// Get pricing information
GET /api/v1/cpq/pricing

Use Cases

• Sales quote automation
• Product configuration
• Pricing rule integration

Sample Request

curl -X POST https://api.industrysoftware.com/v1/cpq/configure \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "CONFIG-001",
    "options": {
      "color": "blue",
      "size": "large",
      "features": ["premium", "extended-warranty"]
    },
    "quantity": 10,
    "customer_id": "CUST-001"
  }'

Response Example

{
  "configuration_id": "CONF-2024-001",
  "product_id": "CONFIG-001",
  "options": {
    "color": "blue",
    "size": "large",
    "features": ["premium", "extended-warranty"]
  },
  "quantity": 10,
  "pricing": {
    "unit_price": 1500.00,
    "discount": 50.00,
    "tax": 145.00,
    "total_price": 15950.00
  },
  "availability": {
    "status": "in_stock",
    "estimated_delivery": "2024-01-25"
  },
  "valid_until": "2024-01-22T23:59:59Z"
}

Configuration Features

• Rule-based product configuration
• Real-time pricing calculations
• Inventory availability checking
• Quote template customization

API Reference

Explore our comprehensive API reference documentation to learn about all available endpoints, parameters, and responses.

API Endpoints

• ERP: /v1/erp/* - Financial, supply chain, and HR operations
• CRM: /v1/crm/* - Customer relationship management
• WMS: /v1/wms/* - Warehouse management operations
• MES: /v1/mes/* - Manufacturing execution system
• QMS: /v1/qms/* - Quality management system
• PLM: /v1/plm/* - Product lifecycle management
• IMS: /v1/ims/* - Inventory management system
• MRP: /v1/mrp/* - Material requirements planning
• AMP: /v1/amp/* - Asset management platform
• CPQ: /v1/cpq/* - Configure, price, quote

API Base URL

Production:   https://api.industrysoftware.com/v1
Sandbox:      https://sandbox-api.industrysoftware.com/v1

Authentication

All API requests require authentication using OAuth 2.0 Bearer Token. Include your access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Request Headers

Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
X-Client-ID: YOUR_CLIENT_ID
X-Request-ID: UNIQUE_REQUEST_ID

Response Format

All responses are returned in JSON format with the following structure:

{
  "data": { ... },
  "meta": {
    "request_id": "REQ-123",
    "timestamp": "2024-01-15T10:30:00Z",
    "version": "1.0"
  }
}

Error Responses

The API uses standard HTTP status codes:

• 200 OK: Request successful
• 400 Bad Request: Invalid request parameters
• 401 Unauthorized: Invalid or missing authentication
• 403 Forbidden: Insufficient permissions
• 404 Not Found: Resource not found
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error

Sandbox Environment

Use our sandbox environment to test your integration without affecting production data.

• Sandbox URL: https://sandbox-api.industrysoftware.com
• Test data available for all modules
• No rate limits in sandbox
• Real-time API behavior

Getting Started with Sandbox

1. Visit the Developer Portal and create a sandbox account
2. Register your application to get sandbox credentials
3. Use sandbox credentials to obtain test access tokens
4. Start making API calls to the sandbox endpoint

Sandbox Features

• Pre-loaded Test Data: Sample customers, products, and orders
• Real-time Simulation: Simulates production-like behavior
• Test Webhooks: Test webhook delivery without affecting real systems
• Usage Analytics: Monitor your API usage in sandbox

Creating Test Data

// Create test customer
curl -X POST https://sandbox-api.industrysoftware.com/v1/crm/customers \
  -H "Authorization: Bearer SANDBOX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Test Customer",
    "email": "test@example.com",
    "industry": "Testing"
  }'

Resetting Sandbox Data

You can reset your sandbox environment to the initial state at any time from the Developer Portal.

Support

Need help with your integration? Our developer support team is here to assist you.

• Developer Forum: Join our community forum to ask questions and share knowledge
• Support Ticket: Submit a support ticket for technical assistance
• Email: developer-support@industrysoftware.com
• Phone: +1 (800) 123-4567 (Monday-Friday, 9am-5pm EST)

Support Channels

Support Tiers

Best Practices for Getting Help

• Check Documentation: Review our comprehensive documentation first
• Use Sandbox: Reproduce issues in sandbox before reporting
• Provide Details: Include error messages, request IDs, and steps to reproduce
• Test Cases: Provide minimal test cases that demonstrate the issue