Wiki
Open free sandbox

Web API Link

Call a configured operation and read the response.

Configured HTTP operation, through Connection Service, to Mapped tags in the project.Configured HTTP operationConnection ServiceMapped tags

Set it up

  1. Stop the PLC and add a Web API Link from I/O Links.
  2. On Connection, set up the API connection. Import its OpenAPI catalog from a supported file or HTTPS address.
  3. Choose an operation and review the method, route and required inputs. A catalog import alone does not make a request.
  4. Finish API setup in Connection before using live requests. Local API calls use the Connection Service.
  5. Bind the operation’s inputs and outputs in the instruction settings. Watch the returned status and diagnostics when testing.

Check before you run

  • The API base URL is where requests go. The OpenAPI document describes its routes; it is a different address.
  • Credentials belong in connection setup, never in a PLC tag or a saved project file.
  • Only configured operations can be called. A Link is not permission to make arbitrary network requests.
  • A request may fail after the remote service has received it. Check the result before repeating a write.

If it will not connect

Check the Connection Service indicator, the device or server address, and the Link’s diagnostics. A saved mapping does not mean the device is connected. Stop the PLC before changing the Link.

Related