REST API

API v2

Публичный API для интеграций с системой тендеров ФраймЗакупки (zakupki.fraim.ru). Получайте доступ к тендерам, фильтрам, избранному и управляйте балансом.

Stable v2.0
Требуется лицензия

Для работы API требуется действующая лицензия. Для покупки лицензии обратитесь к сопровождающему менеджеру или напишите на info@fraim.ru.

Важно

Этот API предназначен только для сервер-сервер интеграций. Запросы из браузера будут заблокированы (отсутствует CORS).

Базовый URL

Base URL 
https://zakupki.fraim.ru/api/v2
Интерактивная документация

Для тестирования API и просмотра всех эндпоинтов используйте Swagger UI — интерактивную документацию с возможностью выполнять запросы прямо в браузере.

Авторизация

Все запросы требуют API токен в заголовке X-API-Token:

HTTP Headers 
X-API-Token: your_api_token_here

Подробнее об аутентификации →

Эндпоинты

Авторизация

POST /tokens

Создаёт новый API токен для доступа к API. Токен показывается только один раз.

Требуется авторизация

GET /tokens

Возвращает список всех API токенов пользователя (без самих токенов).

DELETE /tokens/{id}

Удаляет указанный API токен. После удаления токен перестаёт работать.

Тендеры

GET /tenders

Возвращает список тендеров по указанному фильтру с пагинацией. За каждый новый тендер списывается единица баланса.

GET /tenders/{id}

Возвращает полную информацию о тендере: лоты, позиции, документы.

GET /tenders/{id}/positions

Возвращает только позиции тендера с отдельной пагинацией.

Подробная документация по тендерам →

Фильтры

Управление фильтрами (создание, редактирование) выполняется в веб-интерфейсе.

GET /filters

Возвращает список фильтров текущего пользователя (только чтение).

GET /filters/{id}

Возвращает подробную информацию о фильтре с условиями.

Подробная документация по фильтрам →

Избранное

GET /favorites

Возвращает список тендеров в избранном с пагинацией.

GET /favorites/updates

Возвращает избранные тендеры с обновлениями (update_date > favorited_at). Для отслеживания изменений.

POST /favorites/{tender_id}

Добавляет тендер в избранное текущего пользователя.

DELETE /favorites/{tender_id}

Удаляет тендер из избранного.

Подробная документация по избранному →

Баланс

GET /balance

Возвращает текущий баланс пользователя API v2.

GET /balance/history

Возвращает историю списаний и пополнений баланса.

Подробная документация по балансу →