Migration

Infor ION Connect API Gateway Setup Guide

The Infor ION API Gateway provides a unified REST API layer over all CloudSuite Industrial application endpoints, handling authentication, rate limiting, request routing, and API versioning. External systems connect to CSI exclusively through the ION API Gateway, making its proper configuration essential for all integrations. This guide walks through gateway setup from OAuth2 client registration through production-ready API endpoint publishing.

OAuth2 Client Registration and Authentication

Every external system connecting through the ION API Gateway must authenticate using OAuth2 client credentials flow. Authorized apps are registered in the Infor OS Portal under Admin > Security > Authorized Apps, which generates a credentials file (.ionapi) containing the client ID, client secret, token endpoint URL, and gateway base URL. The .ionapi file is used by client applications to obtain bearer tokens for API calls. Token lifetime is configurable from 1-24 hours with automatic refresh support.

  • Register authorized apps in Infor OS Portal (Admin > Security > Authorized Apps) to generate OAuth2 credentials
  • Download the .ionapi credentials file containing client_id, client_secret, iu (token URL), and pu (gateway URL)
  • Configure token lifetime in the authorized app settings based on integration security requirements (1-24 hours)
  • Implement OAuth2 client_credentials grant flow in external applications using the ci and cs from the .ionapi file
  • Enable token refresh in long-running integrations to prevent authentication failures during extended processing

API Endpoint Registration and Routing

ION API Gateway exposes CloudSuite Industrial endpoints through a versioned URL structure: https://{gateway-host}/IONSERVICES/{suite}/{app}/{version}/. CSI endpoints are auto-registered when the application connects to ION, but custom endpoints require manual registration through the ION API Administration console. Each endpoint registration defines the target service URL, HTTP methods allowed, request/response content types, and rate limiting policies.

  • CSI standard endpoints auto-register at /IONSERVICES/CSI/SyteLine/v2/ covering all IDO-based REST operations
  • Register custom endpoints through ION API Administration specifying target URL, methods, and content types
  • Configure URL path parameters and query string validation rules for each registered endpoint
  • Set per-endpoint rate limits (requests/second, requests/minute) to protect backend CSI application servers
  • Enable request/response logging for specific endpoints during development and troubleshooting phases

Integration Patterns and Error Handling

Production integrations through the ION API Gateway should implement retry logic with exponential backoff, circuit breaker patterns for downstream failures, and comprehensive error handling for HTTP 429 (rate limited), 401 (token expired), and 503 (service unavailable) responses. The gateway returns standard HTTP error codes with Infor-specific error detail payloads in the response body that include correlation IDs for tracing requests through the ION infrastructure.

  • Implement exponential backoff retry logic for transient failures: 1s, 2s, 4s, 8s delays with jitter
  • Handle HTTP 429 responses by respecting the Retry-After header value returned by the gateway rate limiter
  • Detect HTTP 401 errors and automatically refresh the OAuth2 bearer token before retrying the failed request
  • Log Infor correlation IDs from error responses for cross-referencing with ION Event Analytics during troubleshooting
  • Configure circuit breaker thresholds (5 failures in 30 seconds) to prevent cascading failures to backend CSI services

Need to integrate external systems with CloudSuite Industrial? Netray delivers production-ready ION API integrations with monitoring and error handling built in.