How to Set Up SyteLine REST API Endpoints
SyteLine CloudSuite Industrial exposes its business logic through REST API endpoints built on the IDO (Intelligent Data Object) framework. These APIs enable external applications to create, read, update, and delete data in SyteLine using standard HTTP methods. This guide covers endpoint configuration, authentication setup, and best practices for securing and optimizing your SyteLine REST API layer.
Enabling and Configuring IDO REST Services
SyteLine's REST API is powered by the IDO Web Services layer hosted in IIS. Navigate to SyteLine Administration > IDO Runtime Configuration to verify the web services endpoint URL, typically https://[server]/IDORequestService/. Each IDO in SyteLine automatically becomes an API resource when web services are enabled. The IDOProtocol configuration in web.config controls serialization format, timeout values, and maximum payload sizes. Ensure the SyteLine Application Server service is running and the IDO web service pool is configured with adequate worker processes.
- Verify IDO Web Services URL at https://[server]/IDORequestService/IDOWebService.svc for SOAP or /api/ for REST
- Configure IIS application pool identity with SyteLine service account credentials for database access permissions
- Set MaxReceivedMessageSize in web.config to at least 10485760 bytes (10MB) for large payload operations
- Enable CORS headers in IIS for cross-origin API access from web applications and external portals
Authentication and Security Configuration
SyteLine REST APIs support multiple authentication methods. For CloudSuite Industrial multi-tenant environments, configure OAuth 2.0 through the Infor ION API Gateway which provides centralized token management and scoping. For on-premise deployments, Windows Authentication or Basic Authentication with SSL/TLS is standard. Navigate to System Administration > Security > API Keys to generate client credentials for external applications. Each API key maps to a SyteLine user profile that controls data access through the existing role-based security model.
- Configure OAuth 2.0 client credentials in ION API Gateway > Authorized Apps for cloud-based authentication
- Generate API keys in SyteLine Administration with specific IDO-level permissions to limit endpoint access scope
- Enable SSL/TLS certificates on the IIS server hosting IDO web services to encrypt all API traffic in transit
- Implement IP whitelisting in IIS Request Filtering to restrict API access to known client application servers
Building and Testing Custom API Endpoints
Create custom API endpoints by defining new IDOs or extending existing ones through the IDO Designer form. Navigate to Application Administration > IDO Designer to create an IDO with custom properties, methods, and event handlers. Each IDO method becomes an API action endpoint accessible via POST requests. Use tools like Postman or curl to test endpoints against the development environment. The IDO request format follows the pattern /api/[IDOName]/[MethodName] with JSON request bodies matching the IDO property schema defined in the SLIDOs table.
- Design custom IDOs in IDO Designer with specific properties mapped to database views or stored procedures
- Test API calls using Postman collections with environment variables for server URL and authentication tokens
- Implement IDO event handlers (OnLoadCollection, OnInsertItem, OnUpdateItem) for custom business logic validation
- Monitor API performance using SyteLine's IDO Performance Monitor form to identify slow-running queries or bottlenecks
Frequently Asked Questions
What is the rate limit for SyteLine REST API calls?
SyteLine does not impose a default rate limit on REST API calls at the application level. Rate limiting is typically configured at the infrastructure layer through IIS Dynamic IP Restrictions or the ION API Gateway. Production environments commonly set limits of 100-500 requests per minute per client. The ION API Gateway supports configurable throttling policies with burst allowances of up to 50 concurrent requests.
Can SyteLine REST APIs return data in JSON format?
Yes, SyteLine REST APIs support both JSON and XML response formats. Set the Accept header to application/json for JSON responses or application/xml for XML. JSON is the default format for the REST endpoint (/api/) while the SOAP endpoint (/IDOWebService.svc) returns XML. Response payload sizes are limited by the MaxReceivedMessageSize configuration, defaulting to 65536 bytes.
How do I handle pagination in SyteLine REST API queries?
SyteLine REST APIs support pagination through the RecordCap and Bookmark properties in the IDO request. Set RecordCap to limit results per page, typically 100-500 records. Use the returned Bookmark value in subsequent requests to retrieve the next page. The LoadCollection method on any IDO accepts these parameters, enabling efficient retrieval of large datasets without timeout issues.
Key Takeaways
- 1Enabling and Configuring IDO REST Services: SyteLine's REST API is powered by the IDO Web Services layer hosted in IIS. Navigate to SyteLine Administration > IDO Runtime Configuration to verify the web services endpoint URL, typically https://[server]/IDORequestService/.
- 2Authentication and Security Configuration: SyteLine REST APIs support multiple authentication methods. For CloudSuite Industrial multi-tenant environments, configure OAuth 2.0 through the Infor ION API Gateway which provides centralized token management and scoping.
- 3Building and Testing Custom API Endpoints: Create custom API endpoints by defining new IDOs or extending existing ones through the IDO Designer form. Navigate to Application Administration > IDO Designer to create an IDO with custom properties, methods, and event handlers.
Need help building robust REST API integrations with SyteLine? Netray's CloudSuite Industrial developers can architect your API strategy.
Related Resources
How to Set Up SyteLine ION Integration
Step-by-step guide to configuring Infor ION integration with SyteLine CloudSuite Industrial. Learn connection points, BODs, document flows, and ION API gateway setup.
Infor SyteLineHow to Set Up SyteLine Third-Party API Connections
Learn how to connect SyteLine CloudSuite Industrial to third-party APIs. Configure external service calls, authentication, error handling, and data synchronization patterns.
Infor SyteLineHow to Configure SyteLine Webhook Notifications
Learn how to configure webhook notifications in SyteLine CloudSuite Industrial. Set up event-driven HTTP callbacks for order changes, inventory alerts, and workflow triggers.