Enabling Web services

In Siren Investigate, Web services provide the infrastructure for retrieving data from external APIs.

You must enable Web services manually by including the following code block in the Investigate server configuration file:

web_services:
  global:
    enabled: true

A Web service driver is an Investigate plug-in that contains a group of one or more Web services.

Some Web service drivers are provided by Siren, but you can also create your own by using the Web service interface. For more information, see Extending Web services.

After you install these drivers, you must restart Siren Investigate.

The following Web services drivers are available and require tokens:

  • Webhose

  • JsonWhois

  • Twitter

web_services:
  webhose:
    config:
      auth_token: 'my-token'
  jsonwhois:
    config:
      auth_token: 'my-token'
  twitter:
    config:
      key: 'my-consumer-api-key'
      secret: 'my-consumer-api-secret'

The Web service manager plug-in provides an invocation visualisation that allows you to invoke one or more Web services from any dashboard.

This plug-in also creates a Web services dashboard that allows you to query any Web service and see the results immediately in an adjacent table.

On this dashboard, select from the list of registered Web services, and click the Back button to fill in the required inputs and retrieve the data.

image

Disabling Web services

Web services groups can be individually disabled by setting the enabled property in the Investigate server configuration file to 'false':

# web_services.<group>.enabled
web_services:
  twitter:
    enabled: false

Web services can be globally disabled as follows:

web_services:
  global:
    enabled: false

This disables all Web service drivers as well as the Web services feature itself.