Channel API: rate limits

About this article

This article describes the rate-limiting guidelines that apply to the Channel API.

Table of contents

Introduction 

Request rate limits

View rate limits

Introduction

To ensure that ChannelEngine can continue serving its customers and partners efficiently and reliably, it is necessary to make use of rate limiting in the Channel API. The rate limits defined allow ChannelEngine's customers and partners to perform all calls required to conduct their business in a timely manner.

It is recommended that you make use of dynamic throttling and consider the limits and intervals communicated in the response headers.

Request rate limits

To request the rate limit for each endpoint:

1. Go to ChannelEngine's OpenAPI/Swagger page for your environment. If you do not know its URL, replace the term 'example' in the URL https://example.channelengine.net/api/swagger/index.html with the first part of the URL of your ChannelEngine environment. E.g.: if your ChannelEngine environment is Sustainable Suits, its URL should be https://sustainable-suits.channelengine.net/ and its OpenAPI/Swagger URL should be https://sustainable-suits.channelengine.net/api/swagger/index.html.
2. Click Authorize and, in the Value field, enter your Channel API key. To find your Channel API key, open a given channel, and go to Setup, General, API key.
3. Click Close and select the endpoint for which you would like to know the limit.
4. Click Try it out. If the selected endpoint requires parameters, make sure to provide them before clicking Execute. Otherwise, click Execute.
5. In the Response headers section, check the values provided by the headers:

• x-rate-limit-limit - the rate limit interval, in minutes.
• x-rate-limit-remaining - the number of remaining calls within the current interval.
• retry-after - the number of seconds to wait before making another call.

View rate limits 

The table below lists the endpoints and their corresponding rate limits and intervals. E.g.: if a rate limit is 5 and its corresponding interval is 15, you can make 5 calls within 15 minutes.

Channel API