API Key & IP Access

The API Key is used strictly for connecting over API and with third-party tools. The API Settings section allows you to generate an API key and to view and modify allowed IP addresses.

In the Control Panel, from the User menu (mouse over the gear icon at the top of the page), click Account Settings, and then click the API Settings.

API key

This feature displays the back-end “private key” that is used with the client code (scripts). The key is used for authentication and for building a secure socket for client/server communications.

To generate a new key, from the Actions drop-down list, click Generate New Key.

IMPORTANT: Once the new API key is generated, the old key will stop working. You must be ready to make the change to avoid service interruption.

IP access rules

This section allows you to view and modify your IP addresses. There are two limits to using this functionality:

  • You are only allowed a maximum of five (5) rules. If you already have five and want to add an additional rule, you must remove one of the existing ones.
  • You can only add IP addresses with ranges from 25 to 32.

To add a new IP rule

  1. In the IP Access Rules section, click Edit.
  2. In the IP Address field, enter an IP address.
  3. From the CIDR Prefix drop-down list, choose the IP address range.
  4. In the Type section, choose whether to allow or deny the specified IP Address range.
  5. Click Submit.

 

Have more questions? Submit a request

1 Comments

  • Avatar
    Gianni

    I suggest you make the IP Rules section NOT mandatory.
    When your API is fetched from distributed environment, there is no opportunity to get fixed IP easily, and you are this way forcing your users to let all requests pass through a proxy.

Please sign in to leave a comment.
Powered by Zendesk