Comprehensive Guide to Using OPC API Gateway

3 min readDec 5, 2024

Managing API access effectively is a crucial component of modern software systems. OPC API Gateway simplifies this task by offering structured management for applications. This guide will walk you through the steps to create and configure applications within the OPC API Gateway.

Purpose

This guide aims to clarify the process of creating applications in the OPC API Gateway. By following the outlined steps, you can ensure proper alignment of Authentication and Access Levels, facilitating seamless API access management.

Steps to Create an Application

1. Log In

Begin by accessing the OPC API Gateway management interface and navigating to the “Administration / OPC API Gateway” section.

2. Add an Application

Click on the “+ Create Application” button. A new application creation window will open.

3. Enter Basic Information

Name: Assign a unique name to the application, such as CANPRIVATE.
Authentication Level: Choose between L00 (No execution) or L10 (Execute GET). Ensure that the Authentication Level matches the Access Level.
Access Level: Select a level corresponding to the Authentication Level. For example:
Authentication Level: L10 (Execute GET)
Access Level: L10 — PRIVATE_API

Important: Authentication and Access Levels must align. An application cannot interact with services unless its Authentication and Access Levels meet or exceed those of the service.

4. Configure Service and IP Restrictions (Optional)

Allowed Services: Define permitted URIs as a comma-separated list. Example: /api/getRegisteredWebLogicDomains
IP Restriction: Limit access to specific IPs by entering the relevant addresses. Example: 10.70.92.128

5. Set Expiry Date

Specify the application’s validity period by selecting an appropriate expiry date. For instance: 12/06/2024

6. Save the Application

Click the “Save” button to finalize and store the application.

Example Configuration

Here is an example configuration for a successfully created application:

Name: CANPRIVATE
Authentication Level: L10 (Execute GET)
Access Level: L10 — PRIVATE_API
Allowed Services: /api/getRegisteredWebLogicDomains
IP Restriction: 10.70.92.128
Expire Date: 15/12/2025

Viewing Applications

After creating an application, you can find it listed in the Applications Table, which displays the following details:

Name
Authentication Level
Access Level
Allowed Services
Valid Consumer IPs
Token
Expire Date
Enabled Status

Key Considerations

Authentication and Access Levels

These levels must match for the application to function correctly.
Applications with Authentication or Access Levels below the required service level will not have access.

URI Configuration

Ensure that URIs entered in the Allowed Services field are valid and appropriately configured.

Expiry Date

Set a correct expiry date to avoid disruptions caused by expired applications.

Troubleshooting

Application Not Displayed

Ensure that Authentication and Access Levels are aligned.

Access Issues

Verify that the correct URIs are listed in the Allowed Services field.
Check the IP addresses entered in the IP Restriction field.