Webservice API - Get Access From 3rd Party Applications
The ds9 Webservice API is available in all members of the ds9 product family to provide remote access to collected intelligence data without having to login into the ds9 GUI.
Authenticating against ds9 using either a technical user or an API key, 3rd party applications can access ds9 viewers or containers to either display ds9 viewers in proprietary web based applications or further process the data.
Accessing the Webservice API
Data is retrieved in JSON or TSV format and can be delivered zipped or unzipped.
The JSON format returned depends on the container that was accessed.
e.g. the JSON for the Collected News
container from the News Tracker
"Name": "FDA - Recalls, Alerts: Food and Drugs",
"Date": "01/09/2017 14:03:49",
"Headline": "Voluntary Nationwide Recall of all Liquid Products Manufactured by ...",
"Subtitle": "As a precautionary measure, ...",
"Source": "Cardinal Health",
"Icon URL": "https://www.fda.gov/favicon.ico",
"Content URL": "https://www.fda.gov/Safety/Recalls/UCM571001"
Accessing the ds9 Webservice API is as easy as executing an HTTP REST request:
For ds9 Solutions and ds9 Developer's Edition:
https://yourhost.deepsearchnine.com/ds9/cwac?idContainer=[idContainer]&filter=[some lucene query]&format=[JSON|TSV]&zip=zip
Authentication is Basic Authentication
using the credentials of the technical user that was granted permissions to access the specified container.
For ds9 2Go:
https://yourhost.deepsearchnine.com/ds92go/cwac?apiKey=[your API Key]&idContainer=[idContainer]&filter=[some Lucene query]&format=[JSON|TSV]&zip=zip
You have received your API Key together with your registration email and you can also lookup the API Key in the Settings of the ds9 2Go GUI.
can be retrieved from the ds9 2Go GUI when opening the Container viewer (2nd number in the caption).
are optional and default to:
For accessing viewers from outside of ds9 exists the Standard Web App
and for integration with 3rd party applications a ds9App Stub
can be used to call viewers through the webservice API.
Both options come with ds9 Solutions and ds9 Developer's Edition.