Access key management

You can manage demo and production access keys:

• rename a key
• view statuses of a key and services
• enable and disable services in a key
• configure limits for services
• unblock a service
• block a key

Renaming a key

1. Go to the API Keys tab and select the required key.
2. Click Actions and select Edit Name.
3. Enter the new key name and click Save.

Viewing statuses of a key and services

On the API Keys tab, you can view statuses of keys and services in them and the planned or actual date of key blocking.

Statuses are displayed only for enabled services added to the subscription. For example, if the subscription contains 15 services and 10 are enabled in the key, statuses are shown only for those 10.

Possible key statuses:

• Active: key is operating. The service APIs receive requests.
• Inactive: key is manually blocked, or its blocking date has passed.
• Pending subscription: key is not operating due to subscription issues (for example, payment is pending).

Possible statuses of services:

• Green indicator: service is enabled and active. The service API receives requests.
• Red indicator: service is enabled but throttled or blocked due to reaching limits in the key or subscription (a Throttle or Block action was applied when the limit was reached). If the Notification action was configured, the service remains enabled because the API still receives requests.
• Gray indicator: service belongs to a key with status Inactive or Pending subscription.

Enabling and disabling services

You can enable or disable services in keys with the Active status. When a service is disabled, its APIs do not receive requests.

1. Go to the API Keys tab and select the required key.
2. To enable or disable the service, use the toggle to the left of a service name.

Configuring limits for services

You can configure limits only for enabled services that belong to keys with the Active status.

Limits are displayed for all services added to the subscription. If the service belongs to a key with the Inactive status, the limit counter displays 0.

Important

If you specify a limit value for a service that is greater than the subscription limit, the service will be blocked when the subscription limit is reached.

1. Go to the API Keys tab and select the required key.

2. Click icon in the row of the required service.

3. In the Configuring limitations in API key dialog, configure the service limits:

   • Limit Periods: limit duration (minute, day, or month).

   • Limit reached: action taken when the limit is reached:

     • Notification: when the limit is reached, a notification will be sent to the email address specified in your profile. The service continues operating.
     • Throttle: when the limit is reached, the service is temporarily blocked for the limit duration period. The service will be automatically unblocked after the limit period ends. If necessary, you can unblock the service manually.
     • Block: when the limit is reached, the service is blocked. If necessary, you can unblock the service.

   • Limit: number of requests (or responses) for the service, e.g., 1000 per day.

   

4. To add another limit, click Add Limitation and repeat step 3. You can set up to 100 limits per service.

5. Click Save.

Unblocking a service

A service can be blocked after applying the Throttle or Block action when a limit is reached. To unblock a service, in the Configuring limitations in API key dialog, perform one of the following actions:

• Increase the number of requests (or responses) for the service in the Limit field.
• Delete the limit by clicking icon.

Blocking a key

Important

A blocked key cannot be reactivated. Create a new key or contact the manager.

1. Go to the API Keys tab.
2. In the row of the required key, click icon and select Block.