Skip to content

Commit

Permalink
rest API limits documentation is updated (#526)
Browse files Browse the repository at this point in the history
* rest API limits documentation is updated
  • Loading branch information
isumygin-sc authored Oct 12, 2023
1 parent a64335f commit b366c19
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 10 deletions.
2 changes: 1 addition & 1 deletion content/en/user-manual/api/asset-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,6 @@ Status: 201

## Rate Limiting

This route uses a [strict][1] rate limit.
This route uses an [assets][1] rate limit.

[1]: /user-manual/api#rate-limiting
2 changes: 1 addition & 1 deletion content/en/user-manual/api/asset-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,6 @@ Status: 200

## Rate Limiting

This route uses a [strict][1] rate limit.
This route uses an [assets][1] rate limit.

[1]: /user-manual/api#rate-limiting
11 changes: 8 additions & 3 deletions content/en/user-manual/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,15 @@ Also the status code of the response will be the appropriate HTTP error code.

## Rate Limiting

Calls to the REST API have a rate limit. There are different rate limits depending on the request:
Calls to the REST API have a rate limit. Check your actual limits by querying [this endpoint](https://playcanvas.com/api/ratelimits).
There are different rate limits depending on the request:

| Rate Limit Type | Description | Limit for free accounts | Limit for personal/org accounts |
|-----------------|---------------------------|-------------------------------|--------------------------------|
| Normal | The normal rate limit | 120 requests/minute | 240 requests/minute |
| Strict | The strict rate limit | 5 requests/minute | 10 requests/minute |
| Assets | The assets rate limit | 60 requests/minute | 120 requests/minute |

* **normal:** The normal rate limit allows 120 requests per minute.
* **strict:** The strict rate limit allows 5 requests per minute.

The response will contain the following headers to help you regulate how often you call the API:

Expand Down
2 changes: 1 addition & 1 deletion content/ru/user-manual/api/asset-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,6 @@ Content-Type: application/javascript

## Ограничение скорости

Этот маршрут использует [строгое][1] ограничение скорости.
Этот маршрут использует ограничение скорости для [ассетов][1] .

[1]: /user-manual/api#rate-limiting
2 changes: 1 addition & 1 deletion content/ru/user-manual/api/asset-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,6 @@ curl -H "Authorization: Bearer {accessToken}" -X PUT -F 'pow2={pow2}' -F 'file=@

## Ограничение скорости

Этот маршрут использует [строгое][1] ограничение скорости.
Этот маршрут использует ограничение скорости для [ассетов][1].

[1]: /user-manual/api#rate-limiting
12 changes: 9 additions & 3 deletions content/ru/user-manual/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,16 @@ https://playcanvas.com/api/items?limit=32&skip=16

## Ограничение скорости

Запросы к REST API имеют ограничение скорости. Существуют разные ограничения скорости в зависимости от запроса:
Запросы к REST API имеют ограничение скорости.

* **нормальный:** Нормальное ограничение скорости позволяет совершать 120 запросов в минуту.
* **строгое:** Строгое ограничение скорости позволяет совершать 5 запросов в минуту.
Проверьте свои лимиты [здесь](https://playcanvas.com/api/ratelimits).
Существуют разные ограничения скорости в зависимости от запроса:

| Тип лимита | Описание | Лимит для бесплатных акканутов | Лимит для персональных аккантов и организаций |
|-----------------|---------------------------|-------------------------------|--------------------------------|
| Normal | Нормальный лимит | 120 запросов в минуту | 240 запросов в минуту |
| Strict | "Строгий" лимит | 5 запросов в минуту | 10 запросов в минуту |
| Assets | Лимит для загрузки ассетов | 60 запросов в минуту | 120 запросов в минуту |

Ответ будет содержать следующие заголовки, чтобы помочь вам регулировать частоту вызова API:

Expand Down

0 comments on commit b366c19

Please sign in to comment.