Учет доходов и расходов API

Учет доходов и расходов API, Книга Доходов и Расходов управляет своими записями из вашего приложения: просмотр, добавление, обновление и удаление. Эндпоинты работают по API-ключу вместо сессии браузера.

Быстрый старт

Создайте ключ в разделе API для разработчиков вашего аккаунта; ключ в открытом виде отображается только в момент создания.
Отправьте запрос на https://api.pixepi.com с заголовком Authorization: Bearer <key>.
Ответы возвращаются в формате JSON; в эндпоинтах списков можно использовать параметры page, per_page и поля фильтрации.

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

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Аренда"

Эндпоинты этого инструмента

Метод	Путь	Назначение
`GET`	`/categories`	Показывает категории (общие системные и ваши собственные).
`POST`	`/categories`	Добавляет новую категорию.
`POST`	`/categories/{id}`	Обновляет категорию.
`POST`	`/categories/{id}/archive`	Архивирует категорию; повторный вызов не меняет статус.
`GET`	`/entries`	Показывает записи; фильтрует по дате, типу, категории и заметке.
`POST`	`/entries`	Добавляет новую запись.
`POST`	`/entries/{id}`	Обновляет запись.
`POST`	`/entries/{id}/delete`	Удаляет запись.
`GET`	`/summary`	Сводная разбивка: по месяцам, категориям или типам.
`GET`	`/export.csv`	Экспортирует записи в CSV.

Общие эндпоинты

Метод	Путь	Назначение
`GET`	`/api/v1/apps`	Каталог API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Контракт инструмента
`GET`	`/api/v1/usage`	Сводка использования
`GET`	`/api/v1/openapi.json`	Документ OpenAPI 3.1

Ограничения

Поле limit в ответах со списками содержит данные об использовании и лимитах.
Информация о квотах и тарифе привязана к вашему аккаунту; проверьте текущее состояние с помощью GET /api/v1/usage.

Коды ошибок

Код	Значение
`unauthorized`	Ключ API отсутствует или недействителен.
`forbidden`	Эта операция запрещена с данным ключом.
`not_found`	Инструмент, задача или запись не найдены (404 также при доступе из другого аккаунта).
`invalid_input`	Ошибка проверки входных данных (пропущено или повреждено поле, неверная дата и т. д.).
`invalid_request`	Некорректный запрос.
`too_large`	Размер файла или тела запроса превышает лимит.
`unsupported_media`	Тип файла не поддерживается.
`not_supported`	Этот инструмент не может работать на этой конечной точке (stateful app).
`not_ready`	Задача еще не завершена.
`expired`	Срок действия файла истек.
`no_output`	Нет готовых файлов для скачивания.
`invalid_path`	Недопустимый путь к файлу.
`quota_exceeded`	Превышена квота или лимит запросов.
`rate_limited`	Слишком много запросов за короткое время; подождите немного и повторите попытку.
`csrf`	Ошибка проверки формы браузера (внешний API использует ключи).
`conflict`	Операция конфликтует с текущим состоянием.
`unavailable`	Инструмент временно недоступен.
`internal_error`	Непредвиденная ошибка сервера.

Документы

Часто задаваемые вопросы

Где получить API-ключ?

Создайте ключ в разделе API для разработчиков вашего аккаунта; ключ показывается только один раз в момент создания.

Как отправить запрос?

Эндпоинты доступны по адресу https://api.pixepi.com; каждый запрос должен содержать заголовок "Authorization: Bearer <key>".

Какие эндпоинты предоставляет API Книга Доходов и Расходов?

В таблице выше перечислены доступные эндпоинты; все они работают с записями вашего аккаунта и возвращают 404 при попытке межпакетного доступа.

Как обрабатывать ответ с ошибкой?

Тело ошибки содержит поля {ok:false, error, code, request_id}; возможные значения кода приведены в таблице кодов ошибок.