> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt
> Use this file to discover all available pages before exploring further.

# API для разработчиков

> REST API с аутентификацией по персональному токену доступа. Управляйте контактами, кампаниями, шаблонами и настройками программно.

## Обзор

Nudgen Developer API предоставляет чистый, ориентированный на ресурсы интерфейс REST для управления вашей маркетинговой инфраструктурой. Все запросы используют стандартные методы HTTP и возвращают предсказуемые ответы в формате JSON.

<CardGroup cols={3}>
  <Card title="Аутентификация по PAT" icon="shield-check">
    Аутентификация с помощью персональных токенов доступа через стандартный заголовок Bearer.
  </Card>

  <Card title="Чистый REST" icon="globe">
    Предсказуемые, ориентированные на ресурсы URL со стандартными методами HTTP.
  </Card>

  <Card title="Ограничение частоты" icon="gauge">
    Встроенное ограничение частоты запросов (rate limiting) для каждой команды и эндпоинта для защиты ваших рабочих процессов.
  </Card>
</CardGroup>

## Аутентификация

Все API-запросы требуют передачи персонального токена доступа (PAT) через заголовок `Authorization`. Вы можете сгенерировать токены в панели управления Nudgen в разделе **Настройки → API-ключи**.

```bash theme={null}
curl -X GET https://app.nudgen.com/api/v1/user/me \
  -H "Authorization: Bearer <your-pat>"
```

## Базовый URL

Базовый URL для всех API-запросов:
`https://app.nudgen.com`

## Эндпоинты

### Аутентификация и идентификация

* `GET /api/v1/user/me`: Получить данные текущего аутентифицированного пользователя.
* `GET /api/v1/teams`: Список всех команд текущего пользователя.
* `POST /api/v1/teams/switch`: Переключить контекст активной команды.

### Контакты

* `GET /api/v1/contacts`: Список контактов с пагинацией, поиском и фильтрами по тегам.
* `POST /api/v1/contacts/add`: Создать новый контакт.
* `GET /api/v1/contacts/:id`: Получить данные конкретного контакта.
* `PATCH /api/v1/contacts/:id`: Обновить существующий контакт.
* `DELETE /api/v1/contacts/:id`: Удалить контакт.

### Кампании

* `GET /api/v1/campaigns`: Список кампаний в текущей команде.
* `POST /api/v1/campaigns`: Создать новую кампанию.
* `GET /api/v1/campaigns/:id`: Получить детали кампании.
* `GET /api/v1/campaigns/:id/stats`: Получить статистику доставки кампании.

### Шаблоны

* `GET /api/v1/templates`: Список шаблонов писем.
* `POST /api/v1/templates`: Создать новый шаблон письма.

### Настройки

* `GET /api/v1/settings/brand`: Получить конфигурацию бренда.
* `PATCH /api/v1/settings/brand`: Обновить настройки бренда.

## Спецификация OpenAPI

Вы можете скачать нашу полную спецификацию OpenAPI здесь:
[openapi.json](https://app.nudgen.com/api/openapi.json)