Before creating and using a Connector, please review the following requirements and prerequisites.
Create a Vault Entry for your API Account Authentication
To create a Connector, you must first store the authorization information in an Authorization Vault, which provides a secure storage location for API keys, tokens, username and passwords, headers, and other info used to authorize calls to external Web Services. For a Cloud Connector to work, this vault entry must exist and be configured for the external application you wish to communicate with.
The vault entry can be created from the Admin Console’s Settings | Auth Vault view, or directly from the Cloud Connector wizard (shown below).
When creating a vault entry, you must select the correct NetSuite application based on the authentication method you plan to use
If using token-based authentication, then select the NetSuite TBA icon. The credentials required are shown in the Vault Entry Wizard image below.
-
Account number
The Account Number can be found by navigating in NetSuite to Setup > Company > Company Information. -
Consumer Key and Consumer Secret
To obtain these values:- Log in to NetSuite and navigate to Setup>Integrations>Manage Integrations.
- Click the New button and name your integration.
- Select the TOKEN-BASED AUTHENTICATION, TBA: ISSUETOKEN ENDPOINT, and User Credentials options.
- Unselect the TBA: AUTHORIZATION FLOW and AUTHORIZATION CODE GRANT options, which are checked by default.
- Click Save.
- Record the Consumer Key and Secret values displayed in the setup configuration. Note: Be sure to record these values now as they are displayed only once and never again.
-
Token ID and Token Secret
To obtain these values:- Create a role (if not already created) by going to Setup>Users/Roles>Manage Roles>New.
- The role must have required permissions added in Permissions>Setup for integration using TBA (Some standard permissions are shown in the image below).
- Assign the Role to the user to be used for integration. Go to Lists>Employees>Edit user>Access tab>Roles sub-tab.
- Create an Access Token. Setup>Users/Roles>Access Tokens>New. Select the Integration Record, User, and Role created or referenced in the previous steps.
- Click save and record the Token ID and Token Secret displayed.
- Create a role (if not already created) by going to Setup>Users/Roles>Manage Roles>New.
- WSDL URL
The WSDL URL field is automatically populated with a 2016 version. This field can be edited.
- It is recommended that the WSDL version be as close as possible to the NetSuite instance/release version.
- WSDL versions that are 15 versions older than the current NetSuite instance/release version are not supported by NetSuite (This is mentioned in the official NetSuite article Support for Existing WSDL Versions).
- To determine your NetSuite instance/release version, follow the steps in Finding Your NetSuite Release Version.
The format for the WSDL URL as specified in the official NetSuite documentation is
https://webservices.netsuite.com/wsdl/v<version>/netsuite.wsdl
-
Host URL
The Host URL field is read-only by default and is automatically populated once the Account Number and WSDL URL fields are properly provided. If you must manually change the Host URL, click the Edit button (pencil icon) to enable editing.
The format for the Host URL as specified in the official NetSuite documentation ishttps://<accountID>.suitetalk.api.netsuite.com/services/NetSuitePort_<version>
- For NetSuite Sandbox Environments, please ensure the following:
- The format of the Account Number must be
xxxxx_SB1
orxxxxx_SB2
(case sensitive) as mentioned in the official NetSuite documentation. - The Host URL must not be edited manually.
- Once the vault entry is created/updated, the connector project(s) associated with this vault entry (if any) must be updated (make sure to recreate objects) and deployed.
- The format of the Account Number must be
- The format for WSDL URL as specified in the official NetSuite documentation is:
https://webservices.netsuite.com/wsdl/v<version>/netsuite.wsdl
The format for Host URL as specified in the official NetSuite documentation is:
https://<accountID>.suitetalk.api.netsuite.com/services/NetSuitePort_<version>
For more information, always refer to the applicable NetSuite developer documentation.
Specialized Licensing Required
The Application Connector requires a specialized server license. See your Customer Account Manager.
Technical Assumption
Effective use of a Connector assumes the following:
- You are familiar with the development and organization of your external application account.
- You know the particulars of your data and the external processes to manage it.
- You have a general understanding of how to create and share resources, and publish (deploy) integration projects in CIC Studio.
Comments
0 comments
Please sign in to leave a comment.