HTTP

The fetch method allows Frames.sh applications to perform calls to remote API endpoints. This is useful for fetching or managing remote data for use within a Frames.sh application. Below are the parameters for this method.

NOTE: multipart/form content-type that enables features such as file uploads is currently not supported. Please stay tuned for future updates.

Parameter	Comment
method	The method for the fetch call - valid methods are: POST, GET, PUT, & DELETE.
url	The url for the fetch call.
headers	The header for the fetch call. Example: content-type=application/json&authentication=Bearer <token> (this string is parsed within the application to fit the configured method).
options	The options for the fetch call that's included in the body of the request. Example: param1=data1&param2=data2 (this string is parsed within the application to fit the configured method).

Fetch Response

The response of the fetch calls are filtered by JSON or raw text (csv). If the body of the response is a JSON text, the response will be served as a stringified JSON text to the application, all other types of responses are treated as text.

When the status of the response is not 200, an error is thrown and returned to the application.

Example Usage

fetch GET,https://api.host.com,content-type=application/json&authentication=bearer token,param1=data1&param2=data2;
variable fetchResult = @@;
condition find_in fetchResult Error;
    varlog An error has occured: {$fetchResult};
else_condition;
    varlog Result: {$fetchResult};
end_if;

Fetch Image

To fetch image from a given URL and obtain its Base64 data, the fetch_image command can be used. On error, a placeholder image will be provided.

// Fetch an image 
fetch_image <image_link>;
variable imageBase64 = @@;

Questions?

Let us know on [e-mail].