JavaScript API basics

JavaScript APIs are custom HTTP endpoints built directly in integrator.io, which client applications can invoke. They are simply custom-made endpoints. Usually, integrator.io initiates a transfer between applications; however, with JavaScript API, integrator.io receives a request from an external application to trigger a flow, export, or import. The external application sends a request and receives a response from the JavaScript API. JavaScript API also uses synchronous requests to invoke exports and imports. Flows invoked from your JavaScript API script don't guarantee immediate flow execution. This function ensures that the flow is added to the execution queue. JavaScript API logs, errors, and dashboards are not updated. JavaScript API is also the only integrator.io resource that supports returning a response in a format other than JSON.

With JavaScript API, integrator.io receives a request from Shopify to trigger an import or export that makes NetSuite perform a task. For example, Shopify can send a JavaScript API(s) request that invokes an import to create an invoice in NetSuite. In this case, integrator.io didn’t initiate the request; they received it from Shopify.

Your cloud or on-premise app sends a JavaScript API request to integrator.io, which triggers a script that invokes a flow, export, or import. The response is sent back to your app as required by the script. 

JavaScript API is useful when initiating integration tasks like

Create a JavaScript API object

You must be an  account owner or administrator. Then, you can create, modify, or delete the JavaScript API in the Resources menu.

To create a JavaScript API(s):

1. Navigate to Resources → APIs.

2. Click JavaScript tab → + Create API → JavaScript on the upper right-hand side of the screen.

   

3. Enter a unique Name and detailed Description of how the JavaScript API works. Be sure to highlight any nuances you or another user making changes might want to know later.

   

Scripts (required)

Select a script from the list that you’ve already written, click the + icon to start writing your own code in the Create script form, or modify an existing script using the pencil () icon. If you’re starting from scratch, insert a function stub that provides all the required fields for the request and response. Note that if you modify a script in one location, it is modified everywhere.

Tip

Within your script logic, you can support any content type (like  JSON  or XML), any HTTP request method (GET, PUT, POST, etc.), and you can invoke any number of external APIs. The built-in  JS runtime module contains several objects and functions you can script and automate everyday integrator.io tasks.

Function (required)

Enter the name of the function. This is the function name that gets called when a request is sent to JavaScript API(s); although you can write as much code as you need, only the single entry point specified here is initially called and receives any data passed in the HTTP header and body.

The name of the function in the default Handle request stub is handleRequest. If you used a different name, you may find it easiest to click the icon to open the script for editing and copy the exact name (without parentheses) for this Function setting.

Continuing in the Create API pane: Advanced settings 

• Enable ShipWorks authentication (optional): Check this box if you will be receiving HTTP requests from ShipWorks, so that integrator.io provides the required login credentials.

  1. Username (enabled & required, only for authentication): Enter the ShipWorks username you provided during the store setup.

  2. Password (enabled & required, only for authentication): Enter the ShipWorks password you provided during the store setup. Multiple layers of protection are in place, including AES 256 encryption, to keep your password secure. When editing this form later, you must enter this password again; it is stored only for a saved JavaScript API.

Copy your unique endpoint URI

Click the name of a JavaScript API in the list or choose Actions (...) → Edit JavaScript API. Then, click Copy URL to add the contents to your clipboard.

These values are displayed earlier when you click Save in the Create API pane, instead of closing when done.

Sample unique JavaScript API endpoint 

Sample unique JavaScript API endpoint, optional ShipWorks variant Provide the username and password in your request for authentication – no bearer token is required