Preparing to call APIs

After you have chosen the APIs that you will use for your application, review the available documentation for the API and for each operation you will call.

The documentation explains details such as:

  • What data/object models the API uses/supports.
  • The latter part of the URL path to invoke a specific operation on a specific piece of data.
  • Any query-string parameters that are required or optional.
  • What HTTP methods (GET, POST) to use when.

You can view any available API documentation via the ION API application:

  1. Go to Available APIs in ION API.
  2. Double-click an API suite.
  3. Click Endpoints.
  4. To see endpoint documentation, click Documentation.

If you prefer to view documentation programmatically, you can use the these URLs:

  • REST APIs – {ION API BASE URL}/{API CONTEXT}/{ENDPOINT}/ionapi-doc
  • SOAP APIs - {ION API BASE URL}/{API CONTEXT}/{ENDPOINT}?WSDL

These documentation URLs are secured in the same method as the proxy endpoint.