NetSuite Human Capital Authenticate an Element

You can authenticate with NetSuite to create your own instance of the NetSuite Human Capital element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the NetSuite platform.

Due to changes to upcoming NetSuite requirements, we recommend using custom authentication to ensure proper functionality.

Authenticate Through the UI

Use the UI to authenticate with NetSuite and create an element instance as described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you will need the credentials that you identified in API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send API calls to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id for future API calls.

If you are configuring events, see the Events section.

To create an element instance:

1. Construct a JSON body based on your authentication type, either Basic or Custom. See Parameters for detailed descriptions.

   Basic Authentication

   {
     "element": {
       "key": "netsuitehcv2"
     },
     "configuration": {
       "netsuite.sandbox": false,
       "netsuite.accountId": "my_account_id",
       "netsuite.single.session": true,
       "netsuite.single.session.key": "my_unique_key",
       "authentication.type": "Basic",
       "user.username": "my@somewhere.com",
       "user.password": "my_secret_password",
       "netsuite.appId": "my_app_id",
       "event.notification.enabled": false
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

   Custom Authentication

    {
      "element": {
        "key": "netsuitehcv2"
      },
      "configuration": {
         "netsuite.sandbox": false,
         "netsuite.accountId": "my_account_id",
         "netsuite.single.session": true,
         "netsuite.single.session.key": "my_unique_key",
         "authentication.type": "custom",
         "consumer_key": "consumer_key_1234567",
         "consumer_secret": "secret_1234567",
         "token_id": "token_1234",
         "token_secret": "token_secret_1234",
         "filter.response.nulls": true,
         "event.notification.enabled": false
      },
      "tags": [
        "<Add_Your_Tag>"
      ],
      "name": "<INSTANCE_NAME>"
    }
   

2. Call the following, including the JSON body you constructed in the previous step:

   Note: Make sure that you include your User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

Basic Authentication

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "netsuitehcv2"
  },
  "configuration": {
    "netsuite.sandbox": false,
    "netsuite.accountId": "my_account_id",
    "netsuite.single.session": true,
    "netsuite.single.session.key": "my_unique_key",
    "authentication.type": "Basic",
    "user.username": "my@somewhere.com",
    "user.password": "my_secret_password",
    "netsuite.appId": "my_app_id",
    "event.notification.enabled": false
  },
  "tags": [
    "Accounting"
  ],
  "name": "NetSuite Instance 1"
}'

Custom Authentication

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "netsuitehcv2"
  },
  "configuration": {
    "netsuite.sandbox": false,
    "netsuite.accountId": "my_account_id",
    "netsuite.single.session": true,
    "netsuite.single.session.key": "my_unique_key",
    "authentication.type": "custom",
    "consumer_key": "consumer_key_1234567",
    "consumer_secret": "secret_1234567",
    "token_id": "token_1234",
    "token_secret": "token_secret_1234",
    "filter.response.nulls": true,
    "event.notification.enabled": false
  },
  "tags": [
    "Accounting"
  ],
  "name": "NetSuite Instance 1"
}'

Parameters

See Netsuite Human Capital API Provider Setup for directions on how to obtain authentication parameters.

Example Response

In this example, the authenticated element instance ID is 12345 and token starts with ABC/D.... Your values will be different. Make sure that you save the id and token for future requests.

{
    "id": 12345,
    "name": "NetSuite Instance 1",
    "token": "ABC/D/efgHIJK1234lmnopQRS+1tuVWx+yz98765",
    "element": {
        "id": 988,
        "name": "NetSuite Instance 1",
        "key": "netsuitehcv2",
        "description": "NetSuite Human Capital.",
        "active": true,
        "deleted": false,
        "typeOauth": true,
        "trialAccount": false,
        "configDescription": "NetSuite Human Capital",
        "signupURL": ""
    },
    "provisionInteractions": [],
    "valid": true,
    "eventsEnabled": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "cachingEnabled": false
}