Accessing the API Reference

You can view documentation for the RESTful APIs that can be used in AS4 Microservice.

About this task

You can access the API Reference from the AS4 Microservice Web Server Browser. If you are not already logged in to AS4 Microservice, you might have to provide a user ID and password to access the API Reference:

Procedure

  1. Log in to AS4 Microservice.
  2. Click Help > Web Services Browser to open the Web Services Browser.
    Tip: You can also access the API reference directly from the browser with the following URL http://<server name>:<port number>/svc/doc.
  3. Click API Reference.
  4. Optional: Enter the name of a resource or service in Filter to filter the search results.

What to do next

Access the Interactive Console tab on the API Reference page to start working with RESTful APIs.