Version: 8.0

Handle the response of an external web service

Level: beginner

@creatio-devkit/common includes the sdk.HttpClientService service that sends HTTP requests.

To handle the response of an external web service:

Add the dependencies. To do this, add @creatio-devkit/common library as a dependency. The library includes the sdk.HttpClientService service that sends HTTP requests.

View an example that adds the @creatio-devkit/common library as a dependency to the SomeApp_FormPage Freedom UI page schema below.
AMD module dependencies
```
/* Declare the AMD module. */
define("SomeApp_FormPage", /**SCHEMA_DEPS*/["@creatio-devkit/common"] /**SCHEMA_DEPS*/, function/**SCHEMA_ARGS*/(sdk)/**SCHEMA_ARGS*/ {
    return {
        ...
    }
});
```
Add an attribute. Instructions: Set up the field display condition (step 2).
Bind an attribute to the label. Instructions: Set up the field display condition (similarly to step 3). Instead of the visible property, use the caption property that handles the text displayed in the element.

Implement the base request handler.

Go to the handlers schema section.
Add a custom implementation of the crt.HandlerViewModelInitRequest base request handler.
1. Create an instance of the HTTP client from @creatio-devkit/common.
2. Specify the URL to retrieve required data. If a web service request is sent using a non-absolute path (without https:// or http:// prefixes), this is a request to an internal Creatio web service. In this case, Creatio automatically adds the address of the current app to the link.
3. Send a GET request.
4. Retrieve required data from the response and specify data in the corresponding attribute.

View an example of a crt.HandleViewModelInitRequest request handler that sends a request to the https://SomeUrl web service, receives the someValue parameter from the response body, and specifies the parameter in the SomeAttribute attribute, below.

handlers schema section
handlers: /**SCHEMA_HANDLERS*/[
    {
        request: "crt.HandleViewModelInitRequest",
        /* Custom implementation of a system request handler. */
        handler: async (request, next) => {
            /* Create an instance of the HTTP client from “@creatio-devkit/common.” */
            const httpClientService = new sdk.HttpClientService();
            /* Specify the URL to retrieve required data. */
            const endpoint = "https://SomeUrl";
            /* Send a GET request. The HTTP client converts the response body from JSON to a JS object automatically. */
            const response = await httpClientService.get(endpoint);
            /* Retrieve the “someValue” parameter from the response body and specify it in the “SomeAttribute” attribute. */
            request.$context.SomeAttribute = response.body.someValue;
            /* Call the next handler if it exists and return its result. */
            return next?.handle(request);
        }
    }
]/**SCHEMA_HANDLERS*/,

See also​

See also