Comprehensive Guide to NetSuite HTTPS Request Parameters in SuiteScript 2.x

Making HTTPS requests in Oracle NetSuite using SuiteScript 2.x involves several key parameters that must be understood to effectively interact with external services. This guide explains these parameters and provides best practices to avoid common pitfalls.

Understanding HTTPS Requests in NetSuite

NetSuite's SuiteScript 2.x allows developers to make HTTPS requests via the N/https module. This is vital for integrating NetSuite with external web services, whether RESTful services or other APIs.

Key Parameters

In configuring an HTTPS request in SuiteScript, the following parameters are essential:

options.method: This required parameter defines the HTTP method for the request (GET, POST, PUT, DELETE, etc.). It must be set using https.Method.
options.url: A required fully qualified URL specifies the target of the request.
options.body: An optional parameter, it contains the body of your request, applicable when the method is POST, PUT, or PATCH.
options.headers: Optional. Headers for the request, specified as a JavaScript object.
options.credentials: Optional. An array of GUIDs used to replace placeholders in the body with decrypted credentials.

Error Handling

When making HTTPS requests, you might encounter errors such as:

SSS_INVALID_HOST_CERT: Indicates an untrusted certificate. Verify the domain name's correct syntax and spelling.
SSS_INVALID_URL: Triggered by specifying an incomplete or incorrect URL.
SSS_MISSING_REQD_ARGUMENT: Caused by leaving out required arguments such as options.method or options.url.
SSS_REQUEST_LOOP_DETECTED: Occurs when a script recursively calls itself too many times, potentially leading to infinite recursion.
SSS_REQUEST_TIME_EXCEEDED: Results from a timeout during connection establishment or payload transmission. Ensure your connections complete within 5 seconds and payloads transfer within 45 seconds.

Best Practices

Timeout Awareness: Be mindful of the 5-second connection and 45-second payload timeout limits to avoid SSS_REQUEST_TIME_EXCEEDED errors.
Certificate Verification: Ensure valid SSL certificates for host verification to prevent SSS_INVALID_HOST_CERT errors.
Error Handling: Implement robust error handling to gracefully manage different error scenarios.

Example Usage

Here is a basic syntax to implement an HTTPS request in SuiteScript 2.x:

var headerObj = {
  name: 'Accept-Language',
  value: 'en-us'
};

var response = https.request({
  method: https.Method.GET,
  url: 'https://www.example.com',
  headers: headerObj
});

This example demonstrates setting headers and method type for an HTTPS GET request.

Key Takeaways

Properly configure required parameters like method and url to ensure successful requests.
Handle certificates and errors wisely to maintain secure and stable integrations.
Respect timeout settings to avoid unnecessary errors in script execution.

By adhering to these standards, developers can create robust integrations and maximize the capabilities of their NetSuite implementation.