API для выставления счетов и автоматизации документов

Apiin построен по принципу API-first: любое действие в кабинете — создание счёта, генерация PDF, отметка об оплате — доступно и через публичный REST API. Так вы автоматизируете документооборот и связываете Apiin со своей CRM, магазином или биллингом.

Создать API-ключ Как это работает

Что умеет REST API Apiin

API покрывает те же операции, что и веб-кабинет: создание и редактирование счетов на оплату, счетов-договоров и актов выполненных работ, работу с контрагентами и реквизитами, генерацию документов в PDF (движок Typst) и Word, а также отметки об оплате с историей платежей.

Данные передаются в формате JSON поверх HTTPS. Каждый счёт можно выпустить сразу с платёжным QR по ГОСТ Р 56042-2014 и получить публичную ссылку на документ — её удобно отдавать клиенту прямо из своего сервиса.

Счета, счета-договоры и акты — создание, изменение, получение
Контрагенты и реквизиты, автозаполнение по ИНН и БИК
Экспорт документа в PDF и DOCX, публичная ссылка с QR
Отметки о частичной и полной оплате, история платежей

Ключи и права-scopes

Доступ к API выдаётся по ключам. Ключ можно ограничить набором прав (scopes) — например, только выставление счетов без права удаления или доступа к платежам. Это удобно, когда ключ уходит во внешний сервис или скрипт: он получает ровно тот минимум, который нужен для задачи.

Ключи бывают постоянные (для боевых интеграций) и временные (для разовых сценариев и тестов). Ключ передаётся в заголовке авторизации каждого запроса; при компрометации его можно отозвать, не затрагивая остальные интеграции.

Как выставить счёт запросом

Типовой сценарий: ваш сервис отправляет запрос на создание счёта с реквизитами продавца и покупателя, позициями и НДС-режимом («Без НДС», УСН или ОСНО), а в ответ получает идентификатор документа, ссылку на PDF и публичную ссылку с платёжным QR. Дальше эту ссылку можно показать клиенту или отправить ему на email.

Точные пути эндпоинтов, поля запроса и примеры ответов описаны в документации на /docs/api — там же приведены форматы автонумерации и работа с наборами оформления, чтобы счета из API выглядели так же, как выпущенные вручную.

Вебхуки и события

Чтобы не опрашивать API в цикле, подпишитесь на вебхуки. Apiin присылает POST-уведомления о создании документа, смене статуса оплаты (частичная и полная) и смене статуса подписи акта. Тело уведомления подписывается по HMAC — вы проверяете подпись и доверяете источнику.

Так реализуется автозакрытие сделки на вашей стороне: получили событие «оплачен» — открыли доступ к услуге; получили «акт подписан» — закрыли задачу. Подробнее о событиях и проверке подписи — на странице про вебхуки.

Сценарии автоматизации

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

Если нужна периодичность без своего кода, в самом Apiin есть повторяющиеся счета с автогенерацией по расписанию и автоотправкой на email — их можно комбинировать с API там, где нужна дополнительная логика.

Частые вопросы

Нужно ли платить за доступ к API?

Нет, Apiin бесплатный, API входит в сервис. Достаточно создать ключ в кабинете и указать нужные права-scopes.

Чем постоянный ключ отличается от временного?

Постоянный ключ живёт до отзыва и подходит для боевых интеграций. Временный удобен для разовых задач и тестов — его безопаснее выдавать наружу.

Можно ли ограничить, что делает ключ?

Да. У ключа есть права-scopes: например, разрешить только создание счетов и запретить удаление или доступ к платежам. Ключ получает ровно нужный минимум.

Можно ли через API выставлять счета-фактуры или УПД?

Нет. Для счетов-фактур и УПД со статусом 1 нужен оператор ЭДО (Диадок, СБИС). Через API Apiin выставляются счета на оплату, счета-договоры и акты.

Где посмотреть точные эндпоинты и примеры?

Полное описание методов, полей и примеры запросов — в документации на /docs/api. Начать интеграцию проще всего с создания счёта и подписки на вебхуки.