Документация pdfapi

pdfapi преобразует HTML, страницу по адресу, Markdown и документы Word, Excel и PowerPoint в PDF, используя HTTP-запрос. Запускать собственный Chromium и LibreOffice не нужно.

Как это работает#

Каждый документ — один запрос к POST /v1/convert. В теле — что нужно преобразовать в PDF и как оформить страницу:

bash

curl -X POST https://pdfapi.ru/api/v1/convert \
  -H "Authorization: Bearer $PDFAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"html","html":"<h1>Счёт №42</h1>","options":{"marginTop":"20mm"}}' \
  -o invoice.pdf

Запрос встаёт в очередь рендера: HTML, страницы и Markdown печатает Chromium, документы Office — LibreOffice. Готовый PDF приходит в ответе, а расход страниц — в его заголовках. Готовый PDF хранится приватно и в зашифрованном виде 24 часа для повторной выдачи без списания. Исходники после обработки не сохраняются.

Основные понятия#

Источник — из чего делается PDF: html, url, markdown или office. На бесплатном тарифе доступен только HTML.

Страница — единица, в которой считается лимит, то есть страница готового PDF. Документ на сорок страниц отнимает от лимита 40 страниц. Запросы не считаются — тариф ограничивает только их число в секунду. Если рендер не удался, страницы не списываются.

Период — месяц, на который выдан лимит страниц. На платном тарифе он начинается с даты оплаты, на бесплатном сервис считает по календарным месяцам.

Ключ — строка вида pdf_live_… для заголовка Authorization. Ключей может быть несколько — по одному на окружение. Лимит частоты считается на каждый ключ отдельно.

Что дальше#

Начните с блиц-старта: за пять минут у вас будет ключ и первый PDF-документ. Если пишете на Python, Node.js, Go, PHP или C#, возьмите готовую библиотеку — она сама повторит запрос при перегрузке сервиса и проверит параметры до отправки. Библиотеки легко встраиваются в проект, а синтаксис у них максимально простой.

Объёмы больше 100 000 страниц в месяц и интересующие вопросы — через заявку на индивидуальный расчёт.