Calling a third-party script from button code

There are two functions that can call an external server from Totum. In fact, there are more, but we are interested in these two:

• linkToScript — opens a window!

• getFromScript — performs an action in the background!

For example, we need to call an external server, pass it request parameters, and do something with the received response. For instance, let's write the response to the h_data field:

We pass POST parameters (they are not visible in the address bar):

=: set(table: $#ntn; field: 'h_data' = $script)

// Option when we manually enter post parameters

script: getFromScript(uri: "https://example.host/api/uri/"; post: "action" = "select"; post: "key" = "oIpOyDHca3tSQZIz3ZjY"; post: "params" = $params; timeout: 30)
    params: jsonCreate(data: $paramsJsonData)
        paramsJsonData: rowCreate(field: "user" = #user; field: "type" = "new")

=: set(table: $#ntn; field: 'h_data' = $script)

// Option when we pass post parameters as a row

script: getFromScript(uri: "https://example.host/api/uri/"; posts: $data; timeout: 30)

data: rowCreate(field: "action" = "select"; field: "key" = "oIpOyDHca3tSQZIz3ZjYRZGqQd0yvqXYwQ"; field: "params" = $params)
    params: jsonCreate(data: $paramsJsonData)
        paramsJsonData: rowCreate(field: "user" = #user; field: "type" = "new")

We pass GET parameters (they are visible in the address bar):

=: set(table: $#ntn; field: 'h_data' = $script)

// Option when we pass post parameters as a row

script: getFromScript(uri: "https://example.host/api/uri/"; gets: $data; timeout: 30)

data: rowCreate(field: "action" = "select"; field: "key" = "oIpOyDHca3tSQZIz3ZjYRZGqQd0yvqXYwQ"; field: "params" = $params)
    params: jsonCreate(data: $paramsJsonData)
        paramsJsonData: rowCreate(field: "user" = #user; field: "type" = "new")

Important: when making such a request to an external server, if the timeout parameter is not set, the Totum process will wait for a response indefinitely and will not terminate based on an internal timeout.

If timeout is set, then upon its expiration, in the absence of a response from the external server, an exception will be triggered, similar to the errorException function.

Yes, getFromScript is one of the exception functions. But you need to be very careful with this, as a delay in the response from an external server will cause the table to hang!