Справочник API

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

Скачать openapi [v2] Скачать openapi [v1]

Если вам нужна помощь, пожалуйста, свяжитесь с нами через Discord. Для поддержки по живым играм смотрите нашу систему тикетов.

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

Создайте (и просмотрите) ваши секретные токены для Edgegap API в Панель управления - Настройки пользователя / Токены.

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

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

Не интегрируйте конечные точки Edgegap API в игровой клиент, так как ваш API-токен предоставляет неограниченный доступ к вашей учетной записи. Смотрите для безопасных клиент-ориентированных конечных точек и функций.

Если ваши секретные токены скомпрометированы, удалите их и обновите пароли участников организации.

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

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

{
  "count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "pagination": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}

Для ответов с пагинацией используйте параметры 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 вашей организации:

• Развертывания до 40 запросов в секунду,

• Развертывания до 10 запросов в секунду.

Свяжитесь с нами на планируйте релизы, проводите нагрузочные тесты, оценивайте трафик при запуске и готовьтесь к успеху.