# Справочник API

Получите доступ к функциям управления ресурсами Edgegap с помощью HTTP-запросов.

<a href="https://raw.githubusercontent.com/edgegap/openapi-specification/refs/heads/main/edgegap-v2-openapi.yaml" class="button primary" data-icon="square-down">Скачать openapi \[v2]</a> <a href="https://api.edgegap.com/swagger.json" class="button secondary" data-icon="square-down">Скачать openapi \[v1]</a>&#x20;

### Токен аутентификации

Сгенерируйте (и просмотрите) ваши секретные токены для Edgegap API в [Панель управления - Настройки пользователя / Токены](https://app.edgegap.com/user-settings?tab=tokens).

Добавляйте ваш секретный токен в каждый API-запрос как HTTP-заголовок (включите слово `токен`):

`Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62`

{% hint style="danger" %}
**Не интегрируйте конечные точки Edgegap API в игровой клиент, так как ваш API-токен предоставляет неограниченный доступ к вашей учетной записи. Смотрите** [Broken link](https://docs.edgegap.com/ru/docs/broken-reference "mention") **для безопасных конечных точек и функций, ориентированных на клиента.**
{% endhint %}

{% hint style="success" %}
Если ваши секретные токены скомпрометированы, удалите их и обновите пароли участников организации.
{% endhint %}

### Пагинация ответа

Если ответ содержит слишком много элементов, мы возвращаем подмножество данных с информацией о пагинации:

<pre class="language-json"><code class="lang-json">{
  "count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "<a data-footnote-ref href="#user-content-fn-1">pagination</a>": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}
</code></pre>

Для постраничного ответа используйте параметры `page` и `limit`  чтобы получить больше результатов:

* вторая страница: `https://api.edgegap.com/v1/apps?`**`page=2`**
* больше результатов: `https://api.edgegap.com/v1/apps?`**`limit=20`**
* вместе: `https://api.edgegap.com/v1/apps?`**`page=2&limit=20`**

### Ограничение частоты запросов

Чтобы обеспечить стабильность платформы и предотвратить неожиданные счета, мы ограничиваем частоту использования API вашей организации:

* [deployments](https://docs.edgegap.com/ru/learn/orkestraciya/deployments "mention") на 40 запросов в секунду,
* [#context-and-status](https://docs.edgegap.com/ru/learn/orkestraciya/deployments#context-and-status "mention") на 20 запросов в секунду.

{% hint style="info" %}
[Свяжитесь с нами](mailto:info@edgegap.com) чтобы **планировать релизы, проводить нагрузочные тесты, оценивать трафик при запуске и готовиться к успеху.**
{% endhint %}

[^1]: содержит информацию о пагинации