Migrating TIBCO Spotfire® SOAP Web Services API from the Legacy version to the OAuth 2.0-based version

Last updated:
11:23am May 27, 2019

Back to TIBCO Spotfire® Web Services API Overview page

TIBCO Spotfire® 7.13 introduced a new, OAuth 2-0-based, version of the SOAP Web Services API. The legacy version (/spotfire/ws/pub) has been removed in TIBCO Spotfire® 10.3. To migrate an existing solution follow the steps below:.

1) Update the URLs:

  • http[s]://<host>[:<port>]/spotfire/ws/pub/InformationModelService -> http[s]://<host>[:<port>]/spotfire/api/soap/InformationModelService
  • http[s]://<host>[:<port>]/spotfire/ws/pub/LibraryService -> http[s]://<host>[:<port>]/spotfire/api/soap/LibraryService
  • http[s]://<host>[:<port>]/spotfire/ws/pub/LicenseService -> http[s]://<host>[:<port>]/spotfire/api/soap/LicenseService
  • http[s]://<host>[:<port>]/spotfire/ws/pub/SecurityService -> <no replacement>
  • http[s]://<host>[:<port>]/spotfire/ws/pub/UpdateAnalysisService -> http[s]://<host>[:<port>]/spotfire/api/soap/UpdateAnalysisService
  • http[s]://<host>[:<port>]/spotfire/ws/pub/UserDirectoryService -> http[s]://<host>[:<port>]/spotfire/api/soap/UserDirectoryService

2) Register an OAuth2 API client using the register-api-client command. Make sure to specify the scopes needed for the services that you're accessing. Se API documentation for details.

3) Update the code so that it before making a request to any of the API services obtains an OAuth2 access token (according to the instructions in the API documentation and RFC 6749).

4) Update the code so that it includes the access token from step 3 in an Authorization header (as described in RFC 6750) with every request. The server may respond with 401 if the access token is no longer valid - step 3 must then be repeated.

5) Remove any code for handling other forms of authentication.

6) Remove any code for handling CSRF and sessions (the new API doesn't utilize HTTP sessions and therefore has no need for CSRF protection).

 

Java and C# samples for the SOAP Web Services API can be found here.