API Usage Requirements

This article lists requirements for using the NATS API.

Restrict Access by IP

Recommendation: We recommend that you grant access only to the IP addresses of those who will be actively using the NATS API.

To use the NATS API, you will need to provide a list of IP addresses that will be granted access to the NATS API.

In the Security section of the Configuration Admin, this information is stored as a comma-separated list of IP addresses set in the Admin Allowed IPs setting.

Enable REST API

Recommendation: We recommend enabling only the API systems you plan to use.

In addition to allowing API access to IP addresses, you will need to enable the NATS API itself.

In the Security section of the Configuration Admin, enable the API by clicking the checkbox for the Enable REST API configuration setting and changing the setting to Yes.

This configuration is disabled by default and is available to quickly turn off the NATS API for all users should the need arise.

API Users per System or Server

Recommendation: We recommend creating separate API accounts for separate uses or servers. This ensures that access to the API systems is limited should that account be compromised.

An example of this type of setup would be creating an account for API use in your members area, and creating a separate account for API use on an external Adtool system. If you have members areas on separate servers, it would be best to create a separate account for each server as well.

API Permissions

Recommendation: The permissions system allows you to make available only those systems that an account needs to use. We encourage you to only make available the functions or resources that are necessary to the account itself.

For each account able to access the API system, we provide the ability to restrict the resources or functions available to them.

For example, if an account is to be used for membership authentication, set the account's API permissions to only allow them access to the member search function.

REST API Permissions

By Default, an account does not have access to any of the available REST API resources.

Click the Details button associated with the corresponding admin area to select which of the collection, method, and resource combinations you would like to enable for the account.

Save the configuration by clicking the Save button at the bottom of the modal.

Related Articles

API OverviewAPI Endpoints