API AIARM — интеграция анализа документов в вашу бизнес-систему

REST API для программной интеграции функций анализа документов в корпоративные системы: 1С, SAP, CRM, ERP и пользовательские решения.

API AIARM — REST API для программной интеграции функций анализа документов в корпоративные системы, CRM, ERP и custom-решения.

RESTAPI

JSONформат

Webhooksуведомления

Обзор API

REST-архитектура. Стандартные HTTP-методы, JSON-формат ответов
Версионирование. Стабильный API с обратной совместимостью
Документация. Полная документация с примерами на Python, JavaScript, cURL
Sandbox. Тестовая среда для отладки интеграции
Rate limiting. Прозрачные лимиты с возможностью увеличения

Основные эндпоинты

Загрузка документа. POST /api/v1/documents — загрузка файла для анализа
Статус анализа. GET /api/v1/documents/{id}/status — отслеживание прогресса
Результаты. GET /api/v1/documents/{id}/results — получение результатов
Пакетная загрузка. POST /api/v1/batches — загрузка нескольких файлов
Экспорт. GET /api/v1/documents/{id}/export — выгрузка в нужном формате

Webhooks

Завершение анализа. Уведомление о готовности результатов
Критические риски. Мгновенное оповещение о выявлении критических рисков
Настройка. Выбор событий для подписки
Повторная отправка. Автоматический retry при недоступности эндпоинта

Интеграции

1С. Готовый модуль для интеграции с 1С:Документооборот
Битрикс24. Приложение для Битрикс24 Маркетплейс
SAP. Коннектор для SAP Document Management
Zapier. Интеграция через Zapier для 5000+ приложений

Аутентификация и безопасность

API-ключи. Уникальные ключи для каждого приложения
OAuth 2.0. Поддержка авторизации через OAuth
HTTPS. Все запросы только через зашифрованное соединение
IP-фильтрация. Ограничение доступа по IP-адресам

SDK и библиотеки

Python SDK. pip install aiarm — готовая библиотека для Python
JavaScript. npm-пакет для Node.js и браузера
cURL. Примеры запросов для быстрого старта
Postman. Коллекция Postman с полным набором запросов

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

Есть ли лимиты на количество запросов?

Да, лимиты зависят от тарифного плана. Для Enterprise — настраиваемые лимиты без ограничений.

Есть ли готовая интеграция с 1С?

Да, готовый модуль для 1С:Документооборот позволяет отправлять документы на анализ прямо из 1С.

Попробуйте API AIARM

Зарегистрируйтесь и получите API-ключ для тестирования интеграции.

Получить API-ключ