You can authenticate with NetSuite to create your own instance of the NetSuite ERP connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionality offered by the NetSuite platform.
Authenticate Through the UI
Use the UI to authenticate with NetSuite and create a connector instance as described in Authenticate a Connector 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 common 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 connector instance with a token and id for future API calls.
If you are configuring events, see the Events section.
To create a connector instance:
Construct a JSON body based on your authentication type, either Basic or Custom. See Parameters for detailed descriptions.
Basic Authentication
{ "element": { "key": "netsuiteerpv2" }, "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": "netsuiteerpv2" }, "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>" }
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.Locate the
token
andid
in the response and save them for all future requests using the connector instance.
Example cURL
Basic Authentication
curl -X POST \
https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
"key": "netsuiteerpv2"
},
"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.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
"key": "netsuiteerpv2"
},
"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 ERP API Provider Setup for directions on how to obtain authentication parameters.
Parameter | Description | Data Type | Required |
---|---|---|---|
'key' | The connector key. netsuiteerpv2 | string | |
Namename | The name for the connector instance created during authentication. | Body | |
Connect TO Sandboxnetsuite.sandbox | whether to use a NetSuite sandbox | boolean | Y |
Account IDnetsuite.accountId | the NetSuite account ID | string | Y |
Enforce Single Sessionnetsuite.single.session | whether to use single session to limit API requests to this account | boolean | N |
Specify Single Session Lock Keynetsuite.single.session.key | the unique key for this single session (only applicable if single session = true) | Y if enforcing | |
Authentication Typeauthentication.type | The authentication type, which must be either basic or custom | string | Y |
Emailuser.username | The email of a NetSuite authenticated user (only applicable for Basic authentication) | string | Y if Basic Authentication |
User Passworduser.password | The password of a NetSuite authenticated user (only applicable for Basic authentication) | string | Y if Basic Authentication |
App ID netsuite.appId | The App ID of a NetSuite integration (only applicable for Basic authentication).Complete these steps to find the App ID for your integration:
Your Application ID is then generated. | string | Y if Basic Authentication |
Consumer Keyconsumer_key | For Custom authentication, the consumer key of a token-based NetSuite integration. | string | Y if Token Based Authentication |
Consumer Secretconsumer_secret | For Custom authentication, the consumer secret of a token-based NetSuite integration. | string | Y if Token Based Authentication |
Access Token IDtoken_id | For Custom authentication, the token ID of a token-based NetSuite integration. | string | Y if Token Based Authentication |
Access Token Secrettoken_secret | For Custom authentication, the token secret of a token-based NetSuite integration. | string | Y if Token Based Authentication |
Filter null values from the responsefilter.response.nulls | whether or not to filter out null values from the response | boolean | N |
Example Response
In this example, the authenticated connector 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": "netsuiteerpv2",
"description": "NetSuite ERP.",
"active": true,
"deleted": false,
"typeOauth": true,
"trialAccount": false,
"configDescription": "NetSuite ERP",
"signupURL": ""
},
"provisionInteractions": [],
"valid": true,
"eventsEnabled": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"cachingEnabled": false
}