Что раскрывает наш PDF API — кредиты и лимиты
Страницы API имеют тенденцию расти быстрее, чем API. В нашем списке теперь перечислены только маршруты, которые завершаются без браузера: учетная запись, Редактировать и Сравнить. Это намеренно. Конечная точка, которая не может завершить свой рабочий процесс, хуже, чем полное отсутствие конечной точки.
Что сегодня в прямом эфире
- ПОЛУЧИТЬ /v1/me — счет, план и текущий кредитный баланс; 1 кредит за звонок.
- ПОСТ /v1/редактировать-pdf — находите шаблоны, текст или изображения и возвращайте отредактированный PDF-файл с
apply=1. Бесплатно. - POST/v1/сравнить-pdf — статистика, измененные блоки и ключевые различия между двумя PDF-файлами. Бесплатно.
Все трое берут ключ на предъявителя из Моего аккаунта. Результатом является JSON со ссылкой для скачивания, которая живет два часа; оригиналы никогда не изменяются на месте.
Чего нет в API
Сколько API взимает сегодня
Существует всего три маршрута: GET /v1/me стоит 1 кредит, в то время как POST /v1/redact-pdf и POST /v1/compare-pdf стоят 5 кредитов каждый. Плата за слияние или OCR API не взимается, поскольку эти инструменты не являются конечными точками API. Текущие тарифы указаны на Планы и цены страница.
Почему E-Signer — это не маршрут
Подписание — это двойной рабочий процесс браузера: отправитель размещает поля на странице, а получатель открывает ссылку и подписывает. HTTP-клиент не может видеть макет или управлять этой страницей, поэтому «API электронной подписи» остановится до завершения задания. Конверты хранятся на панели инструментов E-Signer; API не создает и не подписывает их.
Ключи и хранение файлов
Относитесь к ключу API как к паролю: один ключ для каждого приложения, меняйте его, если он был вставлен в общедоступный репозиторий, и никогда не помещайте его в JavaScript на стороне браузера. Загруженные файлы являются временными рабочими копиями с неугаданным идентификатором; они не являются хранилищем документов. Храните оригиналы в своем собственном хранилище и рассматривайте ответ API как производную копию. Страница безопасности перечисляет элементы управления и окно хранения.
Что измерить перед обновлением
Отслеживайте три показателя за месяц: успешные звонки, неудачные звонки и кредитный баланс в конце. Redact и Compare платные (по 5 кредитов), поэтому в балансе виден напряженный месяц; Стоимость вызовов учетной записи составляет 1. Если повторные попытки или пиковые месяцы действительно потребляют кредиты, более крупный план обходится дешевле, чем неудачный пакет. Поскольку неиспользованные кредиты переносятся, месяц тишины не будет потрачен впустую.
E-Signer доступен только в браузере. Кто-то должен визуально разместить поля подписи получателя, а получатель должен открыть страницу подписи и подписать ее. HTTP-клиент не может делать ни того, ни другого, поэтому не существует маршрута API для создания, подписания, составления списка или опроса конвертов. Панель управления E-Signer остается подходящим местом для этой работы.
Тот же тест на данный момент удаляет слияние, сжатие, преобразование и редактор из API: их полезный рабочий процесс является интерактивным и перегруженным файлами. Они остаются бесплатными в браузере, а не рекламируются как полуработающие конечные точки.
Что покупает кредит
Кредиты — это предоплаченный баланс, прикрепленный к Коммерческому счету. Сегодня единственными платными маршрутами API являются GET /v1/me по 1 кредиту и «Редактировать и сравнить» по 5 кредитов каждый. Планы по-прежнему включают ежемесячное кредитное пособие, а неиспользованные кредиты переносятся, а не истекают. Мы указываем актуальные тарифы на API на Планы и цены и не публикуйте цены за инструмент для несуществующих маршрутов.
Ключи, ограничения и безопасность
Ключи API отображаются один раз и хранятся только в виде хеша. Отозванный ключ сразу перестает работать. Ответ на ограничения скорости для каждого ключа и IP-адреса 429 с Retry-After, количество загрузок ограничено размером и количеством страниц, а заблокированная или лишенная прав учетная запись не может использовать действующий ключ. страница API документирует три маршрута и их поля запроса.
Начало работы
Создайте учетную запись, активируйте коммерческий план, если вам нужны ключи API, затем создайте ключ в «Моей учетной записи» и позвоните GET /v1/me сначала. Если инструмент браузера может выполнить эту работу, используйте инструмент браузера — он останется бесплатным.