Asynchronous HTTP POST Requests in SuiteScript

TL;DR

This article explains how to send asynchronous HTTP POST requests using SuiteScript. Using the http.post.promise method enables developers to manage promises for more efficient execution of asynchronous calls.

What is Asynchronous HTTP POST?

Asynchronous HTTP POST requests allow your SuiteScript code to send data to a server without blocking the execution of subsequent operations. This can lead to significant performance improvements in applications that rely on external data.

How Does http.post.promise Work?

The http.post.promise method is designed to make an HTTP POST request asynchronously and waits for any pending promises to resolve before proceeding. This is crucial for operations that depend on external resources, ensuring that necessary data is available before further processing.

Syntax Overview

Here’s a general structure of how to use the http.post.promise method in your SuiteScript:

1// Add additional code 
2...
3var headerObj = {
4    name: 'Accept-Language',
5    value: 'en-us'
6};
7http.post.promise({
8    url: 'http://www.example.com',
9    body: 'My POST Data',
10    headers: headerObj
11})
12    .then(function(response){
13        log.debug({
14            title: 'Response',
15            details: response
16        });
17    })
18    .catch(function onRejected(reason) {
19        log.debug({
20            title: 'Invalid Request: ',
21            details: reason
22        });
23    });
24...
25// Add additional code

Important Parameters

The http.post.promise method takes an options object with the following parameters:

Error Handling

When using http.post.promise, it is essential to handle errors properly. Common error codes include:

• SSS_INVALID_HOST_CERT: This error occurs when the server certificate is invalid or untrusted. Make sure that the URL is correct and that it uses valid syntax.

Best Practices for Asynchronous Coding

• Always ensure that you handle both resolved and rejected promises.
• Keep your asynchronous operations concise to avoid callback hell.
• Utilize logging effectively to debug issues with asynchronous calls.

Who This Affects

Roles that may benefit from this functionality include:

• Developers: For building efficient integrations.
• Administrators: When configuring custom scripts for user needs.

Key Takeaways

• The http.post.promise method enables asynchronous HTTP POST requests in SuiteScript, enhancing application performance.
• Proper error handling and logging are essential when working with promises.
• Always ensure that your script types are supported (client and server scripts).