Integration Record Overview

The integration record helps you manage and monitor SOAP web services requests to your NetSuite account. This is especially useful if you have multiple apps sending requests. For example, your sales team uses one app to send new customer data. Your HR team uses a different app to update employee records. Each application can be represented by its own integration record.

For more details, see the following sections:

Benefits of the Integration Record
Application IDs
Endpoint Requirements
Ownership of Integration Records

Benefits of the Integration Record

You can do the following when using integration records for your external apps:

View details about each application – Including application’s name and description in each integration record.
Block an application – You can block an app by using its integration record to block SOAP web services requests. Note that with endpoints 2015.1 or earlier, some requests are handled by the Default Web Services Integrations record, which has its own configuration options. For details, see Blocking SOAP Web Services Requests.
Select permitted authentication methods for an application – Choose authentication methods for an app when creating its integration record: user credentials, token-based, or both. Note that requests using user credentials also need an application ID to be tracked by the correct integration record. (For details, see Application IDs.) Be aware that the permitted authentication methods vary depending on endpoint used. For details, see Endpoint Requirements.

Important:
As of the 2020.2 endpoint, request-level credentials are no longer supported for SOAP web services authentication. The Passport complex type isn't supported. If you attempt to authenticate through request-level credentials in SOAP web services 2020.2 and later endpoints, the web services request isn't processed, and an error message is returned. Ensure SOAP web services integrations with 2020.2 and later endpoints use TBA. Authentication through user credentials continues to be supported in integrations that use SOAP web services 2020.1 and earlier endpoints. For more information, see Token-based Authentication and Web Services.
Distribute an integration record – Distribute an integration record by bundling it for install in other NetSuite accounts. You can configure a record to be automatically installed in other accounts. For details, see Distributing Integration Records.
View an execution log specific to each application – Each integration record's SOAP Web Services Execution Log shows requests from that app only. Without unique integration records, you can view all requests together in the log at Setup > Integration > SOAP Web Services Usage Log. For RESTlets, the execution log only shows data from those using token-based auth.
View a list of all your applications – You can view all your applications at Setup > Integration > Manage Integrations.

Application IDs

Every integration record has a unique application ID. The ID is a 32-character unique identifier generated when you create the record. You can find the ID in the Application ID field on the integration record. Application IDs are only visible in the account where they were created. When a partner distributes an integration record, their customers can't see the application ID in their own accounts.

You need to include an application ID in some SOAP web services requests. If you're using token-based authentication, leave out the application ID.

Use the following guidelines:

Requests using user credentials need an application ID. (For details, see Endpoint Requirements.)
With token-based authentication, never include an application ID, no matter the endpoint. Including an application ID with TBA causes the request to fail.

Treat application IDs as confidential, even though they're not authentication credentials.

Endpoint Requirements

Integration records work with any supported endpoint. Requirements vary depending on the endpoint you use.

2015.1 and Earlier

Note the following if you're using the 2015.1 endpoint or earlier:

You can track requests with the Default Web Services Integrations record. This record requires minimal maintenance. The Default record was created when you upgraded to 2015.2 or enabled Web Services. The Default record behaves differently than the integration records you create. For details on this record, see Default Web Services Integrations Record.
Token-based auth isn't supported with this endpoint. To track a request with a specific integration record, use user credentials and include an application ID. For more details about application IDs, see Application IDs.

2015.2 and Later

When you upgrade to 2015.2 or later, associate SOAP requests with a non-default integration record. Each request needs one of the following:

An application ID with valid user credentials. For more details about application IDs, see Application IDs. With login or ssoLogin, send the application ID one time per session. For details, see Using Application ID with the Login and ssoLogin Operations.
Token-based authentication details. For details on updating your code to authenticate this way, see Token-Based Authentication Details.

Note:

There's one SOAP web services operation that doesn't need authentication or app identification. It is the getDataCenterUrls.

2016.2 and Later

NetSuite 2016.2 introduces two new permissions for non-administrator users to view and manage integration records.

The Integration Applications permission (List type) lets users view the Integrations list page.

The Integration Application permission (Full level, Setup type) allows users to view, edit, and create integration records. This permission also gives access to the Integration field in SOAP Web Services Operations search.

For details about SOAP web services searches, Searching for SOAP Web Services Log Information.

Ownership of Integration Records

Creating an integration record makes it instantly available in your NetSuite account. Your NetSuite account owns the record, and administrators can edit it freely.

You can also install records from other sources in your account:

Records can be installed as part of a bundle.
Integration records can also be installed automatically in some cases. Auto-installation happens when a request references the record's application ID. Auto-installation works for records with token-based authentication or user credential authentication.

Important:

As of 2019.1, when calling the Issue Token endpoint, an Integration record is created and automatically installed in your account. TThe Require Approval preference controls whether the new record is enabled automatically. You can manage the preference at Setup > Integration > Integration Management > SOAP Web Services Preferences. If the Require Approval box is unchecked (set to false), the new application's State is set to Enabled, allowing all requests. If the box is checked (set to true), the State is set to Waiting for Approval. Then, you need to manually enable the record. Until you set the state to Enabled, all requests sent by that application are blocked.

Records that are installed through either of these methods aren't fully editable, because they are considered to be owned by a different NetSuite account. You can only edit the Note and State fields on these records. Other fields can only be changed by the owner account's authorized users, including the permitted authentication options and the Description field. Changes made by the owner are automatically synced to your account. These changes won't appear in your account's system notes.

For more information about creating integration records, see Creating an Integration Record. For more details about distributing integration records, see Distributing Integration Records.