Sales Creatio, team edition
PDF
This documentation is valid for Creatio version 7.13.0. We recommend using the newest version of Creatio documentation.

Web service integration

Bpm’online can integrate with custom REST web services. You can set up web service integration, including web service connection parameters and methods in the [Web services] section of the [Studio] workplace. Alternatively, you can open this section by clicking the [Web service integration setup] link of the System designer.

Note

The complexity of the setup procedure largely depends on how the web service itself is implemented and documented. Most common web service integrations do not require programmer background.

The general setup procedure is as follows:

1.Study the documentation for the REST services that you need to use for resolving your business task and develop a deep understanding of how they are called.

2.For each of the web services:

a.Set up web service properties, including its URI in the [Web services] section.

b.Add HTTP methods that bpm’online can call to trigger web service functions and set up their parameters.

3.Implement calling of the integrated web services as part of your BPMN business processes.

Example

Set up automatic updates of the currency exchange rates in the [Currencies] lookup using a free web service “Fixer” (http://fixer.io/).

Implementation of this example requires that we set up integration with the Fixer service itself, set up a method for obtaining exchange rates for the needed currency, and finally, set up a business process that would call this method at the required intervals and update the [Currencies] lookup.

The following chapters cover web service integration setup, using the “Fixer” REST service as example.

Contents

Studying Web service documentation

Setting up general properties of the web service

Setting up web service methods

Setting up the parsing of the web service response parameters

Testing the web service integration

Did you find this information useful?

How can we improve it?