Interface HttpClient

HTTP service for sending requests to backend endpoints

The HttpClient is the primary interface for making HTTP requests within the Lime platform.

By default, all requests expect JSON responses. For other content types (text, binary data, etc.), set the responseType in HttpOptions.

All methods throw HttpResponseError on HTTP errors (4xx, 5xx status codes).

Example

Basic GET request for JSON data

const http = platform.get(PlatformServiceName.Http);
const data = await http.get('my_addon/endpoint');
console.log(data);

Example

POST request with data and query parameters

const http = platform.get(PlatformServiceName.Http);
const response = await http.post(
    'my_addon/users',
    { name: 'John Doe', email: 'john@example.com' },
    { params: { notify: 'true' } }
);

Example

Error handling with HttpResponseError

const http = platform.get(PlatformServiceName.Http);
try {
    const data = await http.get('my_addon/endpoint');
} catch (error) {
    if (error.name === 'HttpResponseError') {
        console.error(`HTTP ${error.status}: ${error.message}`);
        console.error('Response:', error.response);
    }
}

Example

Downloading a file as blob

const http = platform.get(PlatformServiceName.Http);
const blob = await http.get('my_addon/download/report.pdf', {
    responseType: 'blob'
});
const url = URL.createObjectURL(blob);
window.open(url);