---
title: 'REST API'
description: 'Токены, Bearer-доступ, пример запроса и ссылки на OpenAPI-референс.'
type: doc
locale: ru
canonical: 'https://yoseno.com/ru/docs/integrations/rest-api'
updated: '2026-07-30'
---

# REST API

Токены, Bearer-доступ, пример запроса и ссылки на OpenAPI-референс.

REST API доступен под `/api/v1` и подходит для скриптов, внутренних сервисов, CI,
выгрузок и другой серверной автоматизации.

Для защищённых endpoints нужен персональный API-токен. Запрос выполняется от имени
пользователя, который выпустил токен, и проходит те же проверки ролей и прав.

## Авторизация

Передавайте токен в HTTP-заголовке:

```http
Authorization: Bearer <token>
```

Как выпускать, хранить и отзывать токены, описано в статье
[API-токены](https://yoseno.com/ru/docs/integrations/api-tokens.md).

## Пример запроса

```bash
curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"
```

Замените `{org}` на ID организации. Параметры конкретного endpoint, формат ответа и коды
ошибок смотрите в полной спецификации.

## Лимиты запросов

API защищён от перегрузки ограничением частоты:
- Авторизованный API приложения: 300 запросов в минуту на пользователя или IP.
- Webhook платёжного провайдера: 600 запросов в минуту.
- Публичные endpoints (`/status`, карточки базы знаний): 300 запросов в минуту по IP.

При превышении лимита сервер возвращает HTTP `429 Too Many Requests` с заголовком `Retry-After` (число секунд до повтора) и телом ошибки:

```json
{
  "status": 429,
  "message": "Слишком много запросов. Попробуйте через 30 сек.",
  "errors": {}
}
```

## Полная документация

- [OpenAPI reference](https://yoseno.com/docs/api) — интерактивная документация по endpoints, параметрам и
  схемам ответов.
- [OpenAPI JSON](https://yoseno.com/docs/api.json) — машиночитаемая схема для генераторов клиентов, Postman,
  Insomnia и проверок контрактов.

## Связанные страницы

- [/docs/api](https://yoseno.com/docs/api)
- [/docs/api.json](https://yoseno.com/docs/api.json)
- [API-токены](https://yoseno.com/ru/docs/integrations/api-tokens.md) — Персональные токены и bearer-доступ к \`/api/v1\`.

## Читать дальше

- [О базе знаний](https://yoseno.com/ru/docs/knowledge.md) — Каталог практик и связь с рекомендациями платформы.