Shared Web Server panel - API Type

Document created by chris_stevens Employee on Sep 10, 2015Last modified by brendan_roche778179 on Nov 11, 2016
Version 4Show Document
  • View in full screen mode

The goal of this article is to provide clear information on what each API Type setting does and doesn’t do, as well as some ideas to help reduce any issues when switching this setting in the future.

BASICINTERMEDIATEADVANCED
Endpoint: /ws/simple/xx
Endpoint: /ws/rest/x
Endpoint: /ws/soap/xxx
User Managementxx
Web Service Componentx
Web Services Server Operationxx**
Ability to Access API with Tokenxxx
**See Recommendation section to view how this can still work.

BASIC

Primary use: When integrating “Web Services Server Operation” component (Listeners), and anyone can hit the API (or with a specific token, which isn’t user specific).
Available Endpoints:

  • /ws/simple/
  • /ws/soap/

*If planning on implementing API components anytime in the future, endpoint “/ws/soap/” is recommended.

INTERMEDIATE

Primary use: When integrating “Web Services Server Operation” component (Listeners), and only specific users can hit the API.
Available Endpoints:
  • /ws/simple/
  • /ws/soap/
*If planning on implementing API components anytime in the future, endpoint “/ws/soap/” is recommended.

ADVANCED

Primary use: When integrating API component.
Available Endpoints:
  • /ws/rest/
  • /ws/soap/
*Note, when you use “ADVANCED”, the /ws/simple/ endpoint gets disabled and will no longer work.

Recommendation

If you are currently implementing listeners while using the “INTERMEDIATE” setting, send all requests through the /ws/soap/ endpoint. This way, when you “upgrade” to “ADVANCED”, you can design your API component to still accept requests from /ws/soap/, without needing your applications to change the API call address. This can be achieved within the API Component, by configuring the Base URL to be blank, and by configuring theOperation Name under the SOAP API tab to match what was configured within the listener.
For example, if you were using INTERMEDIATE with the following setting:

Then wanted to implement an API component (using ADVANCED), you’d configure it similar to this:

(No Base API Path)
and

SOAP’s Operation Name (Add) matches the previous listeners Operation Name.
4 people found this helpful

Attachments

    Outcomes