search

sul-dlss / sul_pub

SUL system for harvest and managing publications for Stanford CAP, with controlled API access.
http://cap.stanford.edu
Other
8 stars 3 forks source link

Switch to WoS REST API : SOAP API sunset November 2023 #1609

Closed edsu closed 11 months ago

edsu commented 1 year ago

@lwrubel noticed this alert in HoneyBadger: https://app.honeybadger.io/projects/50046/faults/79686845

Savon::SOAPFault: (soap:Server) The Web of Science SOAP API is scheduled to be sunset on November 1, 2023. All users must update their code to use the Web of Science REST API. For more details and help, see https://support.clarivate.com/ScientificandAcademicResearch/s/article/Web-of-Science-SOAP-API-Sunset-Frequently-asked-questions-FAQs?language=en_US.

peetucket commented 1 year ago

Have already determined we are definitely still use the SOAP based API using the savon gem: https://github.com/sul-dlss/sul_pub/blob/main/lib/web_of_science/client.rb#L3-L15

  1. Example of where we have used the WoS REST client for RIALTO:

https://github.com/sul-dlss-deprecated/rialto-etl/blob/main/lib/rialto/etl/service_client/web_of_science_client.rb

  1. I have requested an API key for testing this API with sul_pub, but we have one for RIALTO already we can use for testing right now: https://github.com/sul-dlss/shared_configs/blob/rialto-etl-prod/config/settings/production.yml#L36-L37

  2. We currently have two WoS clients in sul-pub:

The information on https://support.clarivate.com/ScientificandAcademicResearch/s/article/Web-of-Science-SOAP-API-Sunset-Frequently-asked-questions-FAQs?language=en_US above suggests the Links AMR is replaced with the WoS Starter API, but it may be possible that all of the info in that API is now available via the WoS Expanded API, and we can go down to a single client. All of the identifiers were not available in the SOAP based WoS Expanded API, which led to the complication of having to use two clients.

  1. Documentation for new API:

Documentation for each API is available on the Developer Portal (https://developer.clarivate.com/). Navigate to the individual API page (linked below) and click ‘View swagger definition’ or ‘try it’ on the page to access the documentation. Schema and example responses are also available. Expanded API: https://developer.clarivate.com/apis/wos Starter API: https://developer.clarivate.com/apis/wos-starter Lite API: https://developer.clarivate.com/apis/woslite

  1. Developer portal: https://developer.clarivate.com/ (click "Sign up" and use Stanford email). If you cannot see documentation after registering (since the account may require manual approval by someone at Clarivate), let me know, I have a login I can temporarily share.
peetucket commented 1 year ago

@justinlittman added some info to this ticket about new API.