Web Services API

A Web Services API is available  to remotely interact with the product.

Security

The Web services API is allowed only to authenticated users, through BASIC authentication, who have the Access data integration API permission. For more information about permissions, see Managing rights.

Documentation

A Swagger specification is available to describe the Web Services API. It is available at <node url>/ws-spec on a running node. The versions of the API and Swagger are available in fields apiVersion and swaggerVersion in <node url>/ws-spec.

This specification can be used to generate the client code using Swagger-codegen or other compatible tools.

The product also embeds Swagger UI which allows browsing the specification and interactively invoke the various Web services directly from a browser. The embedded Swagger UI is available at <node url>/ws-doc on a running node.

Querying data

The API allows the execution of the Data Integration queries configured in a node. As a consequence, to query data in a node using the API, you have to first create a query, then to call it using the Web Services API.

Security

The user must have the "Access" permission on the space of the query and the Access the application permission on the application.

Read Queries Web Services API for more information and examples.

Absorbing data

The API allows the execution of the Data Integration mappings configured in a node. As a consequence, to inject data in a node using the API, you have to first create a mapping, then to call it using the Web Services API.

Security

The user must have the Access permission on the space of the mapping and the Data Collection permission on the application.

For more information and examples, see Mappings Web Services API.

Related Links