If JavaScript is disabled, please continue to the
sitemap
.
Infor API Gateway Administration Guide
Home
Home
Back
Back
Forward
Forward
Search
Help
Copy URL
PDF
Print this page
Help
Help
Copy URL
Copy URL
Topic URL copied to clipboard
PDF
PDF
Print
Hide the Table of Contents
Show the Table of Contents
About this guide
Overview
Components
Client applications
API Gateway engine
Target API servers
API backend service
Authentication server
Backend security
Backend protocol HTTPS vs HTTP
Backend authentication
Backend authentication choices
Basic authentication
OAuth 1.0a Zero-Legged Authentication
MutualSSL Authentication
API client development
Application workflow
Preparing to call APIs
Registering the client application
Developing the application
Infor API Gateway SDK
Choosing a grant type
Java web applications
Acquire the OAuth client
Obtain the OAuth token
Use the OAuth token to consume API Gateway
Refresh the access token
Revoke the token
Example implementation
Sample application
Java thick clients
Acquire the OAuth client
Obtain the OAuth token
Use the OAuth token to consume API Gateway
Refresh the access token
Revoke the token
Example implementation
Sample application
.Net web applications
Acquire the OAuth client
Obtain the OAuth token
Use the OAuth token to consume API Gateway CE
Refresh the access token
Revoke the token
Example implementation
Sample application
.Net based thick clients
Request the authorization code
Obtain the authorization code
Obtain the access_token and refresh_token
Calling the service
Revoke the access token
Refresh the token
Revoke the refresh token
Backend applications (Java or .Net)
Register your backend application to obtain an OAuth ClientID and secret
Example HTTP request for the OAuth2 resource owner grant
.Net applications
Sample application
Go applications
OAuth 2.0 Token Management
Application development - handling API errors
Common error statuses
Releasing the application
Time-outs
Infor API Flow
Administration
Limitations
Available APIs
Adding a new API suite
Infor Non-Provisioned
Custom or Non-Infor
Editing the API suite name and description
Adding policies
Adding suite policies
Adding endpoint policies
Editing and deleting policies
Deleting an API suite
API endpoints
Adding an endpoint
Editing endpoint details
Deleting an endpoint
Viewing API endpoint resources
Viewing API endpoint documentation
Adding API endpoint documentation
API deployments
Adding a deployment
Editing a deployment
Deleting a deployment
Viewing deployed endpoints
Associating endpoints
Authorized Apps
Adding a non-Infor application
Editing an application
Deleting an application
Downloading credentials for authorized apps
Resetting the secret key for authorized apps
Emailing the QR code
Disabling an application
Enabling an application
Cloning an application
Issuing a refresh token
API metadata
Configuration
TLS version
Changing the minimum TLS version
General Settings
Export
JWK management
OAuth 2.0
Monitoring
API Gateway Health
API Gateway Monitoring
API Gateway Monitoring settings
API Suite Tracing
API Gateway Info
Search
Most Recent
Search Results
Transaction Details
Request Response Logging
Turning on Detailed Request Response logging in API Gateway Monitoring
Limitations
Authorizations
Authorizing and revoking authorization
Hybrid Deployment
Enterprise Connector
Prerequisites
Limitations
Configuring Enterprise Connector for API Gateway
Enterprise Connector performance metrics
Default installation with a single hybrid service node
Horizontally scaling up to three service nodes
Interpreting the Enterprise Connector status
API Gateway bridge solution
Overview
Common terms
API Gateway bridge solution using API Gateway Bridge
Prerequisites
Overview
Configuration
In your single-tenant or on-premises ION API
In your multi-tenant API Gateway
In your single-tenant/on-premises ION API
Gateway Support for WebSocket
Checking in the Monitoring user interface
Limitations
Backend as a Service
Services
Viewing deployed BaaS services
Viewing BaaS service details
Editing environment variable values for a deployed service
Viewing the log for a deployed service
Viewing the log for a handler type per deployed service
Exporting a BaaS service
Importing a BaaS service
Deleting a BaaS service
Documents
Viewing BaaS documentation
Downloads
Downloading the SDK
Downloading the SDK from Visual Studio Code Marketplace
Monitoring
Viewing requests per API in a deployed BaaS service
Configuration Management
Adding resources to tags
Available APIs
Accessing REST API documentation for BaaS services
Policies
FaultHandling
Header
Quota
CacheResponse
JsonThreatProtection
JsonTransform
QueryParam
RegExThreatProtection
XmlThreatProtection
XmlToJson
CookieRewrite
Throttling
Transformation
Setting query-string parameters for a target API call
Setting headers for a target API call
SetReqHeader
UserSecurityClaims
Maintenance window
OAuth2 scopes
Oauth2 scopes adoption by API Gateway (Infor suites and Infor/non-Infor authorized apps)
Configuring OAuth2 settings in API Gateway
Adding scopes for authorized apps or service accounts
Using a backend service to opt into using scopes
Using a mobile, web, or native application to opt into using scopes
Additional scope-related items to consider while developing authorized apps
Best practices
Open link in new tab
Open link in new window
Copy link to clipboard