Skip to main content

ZAB API Getting Started

The ZAB API allows you to externally interact with NetSuite elements and datasets. The API is used to create a pathway between a source system (e.g. Salesforce, database, server, etc.) and NetSuite so that information can be dynamically added or updated (POST) or retrieved (GET) from NetSuite. The ZoneBilling API should be utilized as the endpoint for integrations necessary for ZoneBilling. This should be used in lieu of the native NetSuite SOAP-based NetSuite Connectors.

To learn more about the ZoneBilling API, please see the Documentation at: https://zab-docs.zoneandco.com/

 

Before you Begin

  • Read the ZAB API documentation for example POST and GET requests.
    • The example requests are not specific to a client’s environment nor are they comprehensive - the samples provide the format but custom fields can be added to a request, a custom record type may be the target record, and the Internal IDs in the calls should be replaced with data from the target account.
  • Be mindful that limitations are dependent on NetSuite: the quantity of records and processing time rely heavily on NetSuite’s capabilities.
    • Review the ZAB Bulk API Requests section of the ZAB API documentation for information on posting multiple records to NetSuite.
    • If there’s a need for more processing speed, another SuiteCloud Processor can be added to handle greater volume.
  • For more information on the ZAB API Authentication Process and setting up Token-Based Authentication, please refer to the Permissions, Authentication & Connection section in the ZAB API documentation.

 

Key Characteristics

  • The ZAB API is a RESTful API, which is a more modern and secure integration protocol.
  • The ZAB API is not limited to the functions of ZoneBilling but can be used to interact with any records within NetSuite.
  • The ZAB API can interact with Automated Processes, which is a key benefit for those who wish to externally trigger key ZAB processes (Execute Rating, Create Transactions, etc.).
  • The ZAB API is accessed via a RESTlet that is installed as part of the ZAB Bundle.

Keep in Mind

  • If you are using Postman or other tools, and connecting a Sandbox account, the Realm (or account Id) must be formatted with an underscore, not hyphenated (i.e. 12345678_SB1).
    • Before you begin, confirm the Account ID under Setup > Company > Company Information > Account Id field.

  • As of NetSuite version 2021.1, Token-Based Authentication (TBA) tokens must leverage the HMAC-SHA256 signature method.

     

 

Was this article helpful?