1. SuiteCloud Platform
  2. SuiteApp Control Center
  3. Control Center API Endpoints
  4. Getting Started with SuiteApp Control Center API Endpoints

Getting Started with SuiteApp Control Center API Endpoints

This guide will walk you through the process of setting up and making API calls using the Control Center REST API endpoints. REST API endpoints allow you to use standard HTTP methods to and from NetSuite using third party applications. The following steps will guide you through configuring your NetSuite account to successfully make API calls.

Step 1: Enable SuiteApp Control Center

You'll need to enable the SuiteApp Control Center feature to distribute and manage SuiteApps.

  1. Go to Setup > Company > Enable Features.

  2. On the SuiteCloud tab, ensure the SuiteApp Control Center box is checked.

Step 2: Enable REST Web Services

You'll need REST Web Services enabled in your NetSuite environment to perform REST operations using the APIs.

  1. Go to Setup > Company > Enable Features.

  2. On the SuiteCloud tab, ensure the REST Web Services box is checked.

Step 3: Add the SuiteApp Release Manager Role

To use the control center endpoints API, you need a NetSuite user with the SuiteApp Release Manager role. Administrator access gives users unrestricted capabilities, increasing potential risk if the credentials are compromised. The SuiteApp Release Manager role is designed for controlled situations to access only the permissions needed for SuiteApp operations.

To set this up, an administrator with the SuiteApp Control Center feature enabled must:

  1. Go to Setup > Users/Roles > Manage Users and click the name of the user you want to have access.

  2. Click Edit.

  3. In the Access subtab, select the SuiteApp Release Manager role and save the record.

Step 4: Create an Integration Record

An Integration Record represents any application that sends web service requests and is required for secure API access and token management. This record will help you monitor the REST requests made to your account. For more information about Integration Records, see Integration Record Overview.

To create an integration record, you must use the OAuth 2.0 authorization framework to enable client applications to access NetSuite through REST web services. For more details, see Create Integration Records for Applications to Use OAuth 2.0.

The following steps will guide you through creating an integration record with OAuth 2.0:

  1. Go to Setup > Integration > Manage Integrations > New.

  2. Enter a Name for your application and set the State field to Enabled.

  3. On the Authentication subtab for OAuth 2.0,

    1. Check the Authorization Code Grant box.

    2. Check the REST WEB SERVICE box.

    3. Provide a valid Redirect URL. The Redirect URL is validated when you save the integration record.

  4. When you save the integration record, a Client ID and Secret will be generated for use in making API calls. Please be sure to copy and securely store this information, as you will need it for future reference.

The following image illustrates the completed integration record:

Related Topics:

General Notices