Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions apps/docs/content/api/authorization.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Авторизация
description: "Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, настройка доступа для администраторов и сотрудников, смена владельца пространства"
description: "Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, headless-интеграции для агентов, настройка доступа для администраторов и сотрудников, смена владельца пространства"
related:
- /api/requests-responses
- /api/errors
Expand Down Expand Up @@ -35,6 +35,16 @@ related:
[Скоупы](#skoupy) определяют только **какие методы** можно вызывать — расширить круг данных за пределы границ типа токена они не могут.
</Info>

### Какой токен выбрать

Выберите тип по задаче, которую решает интеграция:

| Задача | Тип токена | С чего начать |
| --- | --- | --- |
| Скрипт или утилита от вашего имени, личная автоматизация, разовая выгрузка данных | Персональный | [Создание персонального токена](#sozdanie-personalnogo-tokena) |
| Чат-бот, уведомления из внешних систем, обработка вебхуков, интерактивные формы | Бот | [Боты](/guides/bots/overview) |
| Агент или headless-интеграция без участия человека (CI, сервер, облачный воркер) | Бот | [Агенты и headless-интеграции](#agenty-i-headless-integratsii) |

## Кто может создавать токены

Владелец пространства может ограничить, кто может создавать токены и работать с API. Настройки находятся в разделе **Настройки пространства**:
Expand Down Expand Up @@ -62,7 +72,12 @@ related:

## Получение токена бота

Бот виден в пространстве как отдельный участник со своим именем и аватаром. После создания бота его `access_token` доступен во вкладке **API** в настройках бота. Подробнее о создании и настройке бота — в разделе [Боты](/guides/bots/overview).
Бот виден в пространстве как отдельный участник со своим именем и аватаром. Получить его `access_token` можно двумя способами:

- **В интерфейсе** — во вкладке **API** в настройках бота.
- **Через API** — методом [Новый бот](POST /bots): он создаёт бота и сразу возвращает `access_token`. Сохраните токен из ответа — повторно получить его можно только через интерфейс.

Подробнее о создании и настройке бота — в разделе [Боты](/guides/bots/overview).

### Методы, требующие токен бота

Expand All @@ -83,6 +98,12 @@ related:
Authorization: Bearer <ACCESS_TOKEN>
```

## Агенты и headless-интеграции

Агенту или автоматизации без участия человека (CI, сервер, облачный воркер) подходит токен бота — он работает как сервисная учётная запись, не привязанная к конкретному пользователю. Выдайте боту только нужные для задачи скоупы: принцип наименьших привилегий ограничивает круг доступных методов.

Как подключить агента (CLI, llms.txt, Skills) — в разделе [AI-агенты](/guides/ai-agents/overview). Передача токена в headless-режиме (`PACHCA_TOKEN` из секретов) — в разделе [CLI: авторизация](/guides/cli/authentication#ci-i-agenty-headless).

## Скоупы

Скоупы определяют, к каким методам API имеет доступ токен. Разные типы токенов получают скоупы по-разному:
Expand Down
2 changes: 2 additions & 0 deletions apps/docs/content/guides/ai-agents/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ related:

## Как подключить Пачку к агенту

Чтобы агент выполнял действия в API, ему нужен токен. Агенту или автоматизации без участия человека подойдёт **токен бота** — сервисная учётная запись с минимальными скоупами (см. [Авторизация](/api/authorization)). В CI и headless-окружении передавайте токен переменной `PACHCA_TOKEN` из секретов — см. [CLI: авторизация](/guides/cli/authentication#ci-i-agenty-headless).

### llms.txt

Самый простой способ для разовых задач. Скопируйте ссылку в промпт агента — он получит сводку API со ссылками на документацию. Подходит, когда нужно быстро попросить агента сделать что-то конкретное в Пачке.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/guides/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ related:
Для работы с API вам нужен токен доступа. Есть два способа его получить:

- **Персональный токен** — в интерфейсе Пачки: **Автоматизации** > **API** (доступно администраторам)
- **Токен бота** — создайте бота в **Автоматизации** > **Интеграции** > **Чат-боты и Вебхуки**
- **Токен бота** — создайте бота в **Автоматизации** > **Интеграции** > **Чат-боты и Вебхуки** или программно методом [Новый бот](POST /bots)

<Info>Подробнее о типах токенов и скоупах — в разделе [Авторизация](/api/authorization).</Info>

Expand Down
25 changes: 23 additions & 2 deletions apps/docs/public/api/authorization.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
> Расположение: Основы API
> Краткое содержание: Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, настройка доступа для администраторов и сотрудников, смена владельца пространства
> Краткое содержание: Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, headless-интеграции для агентов, настройка доступа для администраторов и сотрудников, смена владельца пространства
> Это Markdown-версия конкретной страницы. Для контекста за её пределами (правила API, полный перечень методов, авторизация) ОБЯЗАТЕЛЬНО открой [llms.txt](https://dev.pachca.com/llms.txt) перед ответом — это сэкономит токены и предотвратит неполный ответ.


Expand Down Expand Up @@ -29,6 +29,16 @@
> [Скоупы](#skoupy) определяют только **какие методы** можно вызывать — расширить круг данных за пределы границ типа токена они не могут.


### Какой токен выбрать

Выберите тип по задаче, которую решает интеграция:

| Задача | Тип токена | С чего начать |
| --- | --- | --- |
| Скрипт или утилита от вашего имени, личная автоматизация, разовая выгрузка данных | Персональный | [Создание персонального токена](#sozdanie-personalnogo-tokena) |
| Чат-бот, уведомления из внешних систем, обработка вебхуков, интерактивные формы | Бот | [Боты](/guides/bots/overview) |
| Агент или headless-интеграция без участия человека (CI, сервер, облачный воркер) | Бот | [Агенты и headless-интеграции](#agenty-i-headless-integratsii) |

## Кто может создавать токены

Владелец пространства может ограничить, кто может создавать токены и работать с API. Настройки находятся в разделе **Настройки пространства**:
Expand Down Expand Up @@ -67,7 +77,12 @@

## Получение токена бота

Бот виден в пространстве как отдельный участник со своим именем и аватаром. После создания бота его `access_token` доступен во вкладке **API** в настройках бота. Подробнее о создании и настройке бота — в разделе [Боты](/guides/bots/overview).
Бот виден в пространстве как отдельный участник со своим именем и аватаром. Получить его `access_token` можно двумя способами:

- **В интерфейсе** — во вкладке **API** в настройках бота.
- **Через API** — методом [Новый бот](POST /bots): он создаёт бота и сразу возвращает `access_token`. Сохраните токен из ответа — повторно получить его можно только через интерфейс.

Подробнее о создании и настройке бота — в разделе [Боты](/guides/bots/overview).

### Методы, требующие токен бота

Expand All @@ -88,6 +103,12 @@
Authorization: Bearer <ACCESS_TOKEN>
```

## Агенты и headless-интеграции

Агенту или автоматизации без участия человека (CI, сервер, облачный воркер) подходит токен бота — он работает как сервисная учётная запись, не привязанная к конкретному пользователю. Выдайте боту только нужные для задачи скоупы: принцип наименьших привилегий ограничивает круг доступных методов.

Как подключить агента (CLI, llms.txt, Skills) — в разделе [AI-агенты](/guides/ai-agents/overview). Передача токена в headless-режиме (`PACHCA_TOKEN` из секретов) — в разделе [CLI: авторизация](/guides/cli/authentication#ci-i-agenty-headless).

## Скоупы

Скоупы определяют, к каким методам API имеет доступ токен. Разные типы токенов получают скоупы по-разному:
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/public/api/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Основы API
- [Обзор](https://dev.pachca.com/api/overview.md): Обзор REST API Пачки: базовый URL, авторизация по Bearer-токену, формат запросов и ответов, клиенты и SDK для CLI, TypeScript, Python, Go, Kotlin, Swift и C#
- [Авторизация](https://dev.pachca.com/api/authorization.md): Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, настройка доступа для администраторов и сотрудников, смена владельца пространства
- [Авторизация](https://dev.pachca.com/api/authorization.md): Авторизация в API Пачки: персональный токен и токен бота, скоупы методов, headless-интеграции для агентов, настройка доступа для администраторов и сотрудников, смена владельца пространства
- [Запросы и ответы](https://dev.pachca.com/api/requests-responses.md): Формат запросов и ответов API Пачки: базовый URL, заголовки Authorization и Content-Type, структура JSON-тела, коллекции Postman и Bruno для тестирования
- [Пагинация](https://dev.pachca.com/api/pagination.md): Пагинация в API Пачки по курсору: две группы методов (списочные и поиск) с разной структурой meta, поля next_page, prev_page, has_next, has_prev, обход всех записей и polling новых данных через prev_page
- [Загрузка файлов](https://dev.pachca.com/api/file-uploads.md): Трёхшаговая загрузка файлов в API Пачки через presigned URL S3: получение подписи, отправка multipart/form-data и прикрепление к сообщению или задаче
Expand Down
2 changes: 2 additions & 0 deletions apps/docs/public/guides/ai-agents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

## Как подключить Пачку к агенту

Чтобы агент выполнял действия в API, ему нужен токен. Агенту или автоматизации без участия человека подойдёт **токен бота** — сервисная учётная запись с минимальными скоупами (см. [Авторизация](/api/authorization)). В CI и headless-окружении передавайте токен переменной `PACHCA_TOKEN` из секретов — см. [CLI: авторизация](/guides/cli/authentication#ci-i-agenty-headless).

### llms.txt

Самый простой способ для разовых задач. Скопируйте ссылку в промпт агента — он получит сводку API со ссылками на документацию. Подходит, когда нужно быстро попросить агента сделать что-то конкретное в Пачке.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/public/guides/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
Для работы с API вам нужен токен доступа. Есть два способа его получить:

- **Персональный токен** — в интерфейсе Пачки: **Автоматизации** > **API** (доступно администраторам)
- **Токен бота** — создайте бота в **Автоматизации** > **Интеграции** > **Чат-боты и Вебхуки**
- **Токен бота** — создайте бота в **Автоматизации** > **Интеграции** > **Чат-боты и Вебхуки** или программно методом [Новый бот](POST /bots)

> Подробнее о типах токенов и скоупах — в разделе [Авторизация](/api/authorization).

Expand Down
Loading
Loading