Документация API v2.0

Связь, достойная
вашего бренда

Полная интеграция Bindly с вашими внутренними системами. RESTful API, мощные вебхуки и нативные SDK позволяют автоматизировать создание коммерческих предложений за считанные секунды.

Получить API Key Посмотреть песочницу

Введение

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

Наш API спроектирован для предсказуемости. Мы используем стандартные HTTP-методы, аутентификацию через Bearer-токены и возвращаем данные в формате JSON.

Для начала работы вам понадобится ключ разработчика, который можно сгенерировать в панели управления вашего аккаунта. Все запросы отправляются на базовый URL: https://api.bindly.com/v2/.

Мы поддерживаем асинхронную генерацию документов: вы отправляете JSON-структуру, а получаете ссылку на готовый PDF-файл через вебхук или методом опроса статуса задачи.

Основные методы

Endpoints

POST

Создание документов

Метод /documents/create позволяет генерировать PDF на основе шаблона. Передавайте динамические данные (цены, логотипы, тексты) через тело запроса.

GET

Получение отчетов

Эндпоинт /analytics/report/{id} возвращает детальные данные о взаимодействии клиента: время просмотра, клики по кнопкам и конверсии.

PUT

Управление шаблонами

Программно обновляйте переменные в ваших шаблонах. Идеально для автоматизации прайс-листов и изменений условий сотрудничества в реальном времени.

События

Webhooks

Не ждите, пока клиент откроет документ. Получайте мгновенные уведомления в вашу систему.

Настройте URL-адреса для событий:

• document.opened — когда PDF впервые открыт
• button.clicked — клик по CTA-кнопке
• form.submitted — если клиент заполнил встроенную форму

Каждое событие подписывается HMAC-SHA256 для обеспечения безопасности передачи данных.

// Пример полезной нагрузки

{
  "event": "document.opened",
  "timestamp": 1715623400,
  "data": {
    "doc_id": "doc_8x92m1",
    "viewer_ip": "192.168.1.1",
    "user_agent": "Chrome/Win"
  }
}

Библиотеки

Официальные SDK

Мы не оставляем вас один на один с документацией. Скачайте наши нативные библиотеки для самых популярных языков программирования.

Python

Поддержка Python 3.8+. Идеально для аналитики и интеграции с Django/Flask.

pip install bindly-sdk →

Node.js

Нативный пакет для серверных приложений и интеграции с Next.js или Express.

npm install @bindly/js →

PHP

Готовая библиотека для интеграции с WordPress, Laravel и Magento.

composer require bindly/connector →

Технические вопросы

Для тарифа Enterprise лимит составляет 1000 запросов в минуту. Для стандартных аккаунтов — 60 запросов в минуту. Превышение лимита возвращает статус 429.

Мы используем стандартные коды HTTP. Ошибки возвращаются в JSON формате с полем error_code и подробным описанием причины сбоя.

Да, используйте префикс sandbox. в URL. В тестовом режиме документы не отправляются реальным клиентам, а аналитика имитируется.

Интеграция

Нужна помощь с кодом?

Наша команда разработчиков готова помочь вам настроить интеграцию под ваши бизнес-процессы.

Написать в техподдержку

Связь, достойнаявашего бренда