Автентифікація та ключі

Bearer-токен. Кожен кінцевий пункт.

Кожен кінцевий пункт продукту PaperOffice-API очікує заголовок Authorization: Bearer. Ніякого OAuth-потоку, ніякого оновлення.

Два типи токенів, десять областей дій, задокументовані ліміти швидкості.

Створити ключ API Запустити перший виклик API

Один заголовок Браузер OAuth не потрібен Можна відкликати в будь-який час

app.paperoffice.ai/account/api

Запит 200 OK Токен дійсний

Заголовок авторизації

Authorization: Bearer po_ut_YOUR_API_KEY

Дозволи

ocr:read
documents:write
jobs:read

Відповідь

{
  "status": "success",
  "job_id": "8f2c1a…",
  "result": { "pages": 3 }
}

Власна інфраструктура в ЄС Ваші дані залишаються в Європі.
ISO 27001 активний Безпека сертифікована.
SOC 2 Type II активний Міжнародні стандарти аудиту.
Понад 24 роки досвіду Перевірено. Стабільно. Майбутнє захищено.

cURL

1curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \2  -H "Authorization: Bearer po_ut_YOUR_API_KEY" \3  -F "[email protected]" \4  -F "idp_collection=invoice" \5  -F "model=basic-pro-max"

1import requests23response = requests.post(4    "https://api.paperoffice.ai/latest/job/add/workflow",5    headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"},6    files={"file_1": open("invoice.pdf", "rb")},7    data={"idp_collection": "invoice", "model": "basic-pro-max"},8)9print(response.json())

1const form = new FormData();2form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");3form.append("idp_collection", "invoice");4form.append("model", "basic-pro-max");56const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", {7  method: "POST",8  headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" },9  body: form,10});11console.log(await response.json());

Перший виклик

Встановіть заголовок, виберіть конвеєр, надішліть

Шлях до /latest/job/add/ — це назва черги завдання: зазвичай у форматі handler___command (наприклад, paperoffice_aiocr___generate), для структурованого IDP — власний workflow конвеєра.

Один заголовок
Authorization: Bearer po_ut_… — більше нічого не потрібно. po_sk_ та po_ut_ не надсилають заголовок Origin.
Конвеєр у шляху
handler___command з трьома підкресленнями; workflow є винятком із власним slug. Точковий запис повертає API з HTTP 400 JOB_CONFIG_INVALID.
Результат або job_id
client_wait за замовчуванням true: API підтримує з'єднання та надає результат inline. Якщо часового вікна недостатньо, повертається HTTP 202 з job_id та poll_url для GET /latest/job/get/{job_id}.

Переглянути каталог API llms-full.txt для вашого IDE

Для idp_collection=invoice рекомендованою моделлю є basic-pro-max: OCR-first обмежує друковані колекції з позиціями все одно до basic-pro-max, тому надіслана модель=premium повертається як model: basic-pro-max.

Типи токенів

Два типи токенів, чітко розділені

Обидва належать до сервера. Вони створюються, обертуються та анулюються в додатку в розділі Обліковий запис → API.

po_sk_ Сервер до сервера

Секретний ключ

Повний доступ у межах облікового запису
Ніколи не передавати в браузерний код
Не потрібен заголовок Origin
Заблоковано для MCP

Керувати секретним ключем

po_ut_ Залежно від користувача

User Token

Можна обмежити окремими областями
Ніколи не передавати в браузерний код
Заголовок Origin не потрібен
Дозволено для MCP

Створити токен користувача

Запити, що надходять безпосередньо з браузера, не проходять через ці два токени, а використовують публічний ключ po_pk_ — прив'язаний до джерела, з обмеженнями за бюджетом та частотою запитів. Переглянути публічні ключі

Дозволи

Десять областей для кожного токена користувача

Токен користувача має рівно ті області, які ви надаєте йому під час створення. Якщо область відсутня, повертається відповідь API з HTTP 403.

Документи документи
Завантаження, завантаження, обробка
Workspaces робочі простори
Керування папками та структурою
Завдання ШІ ai_завдання
OCR, IDP, екстракція
Білінг billing
Перегляд використання та балансу рахунку
Користувачі користувачі
Керування членами команди
Вебхуки вебхуки
Отримання подій
База знань база_знань
База знань та FAQ
Агенти агенти
Налаштування агентів IDP
Робочі процеси робочі процеси
Створення автоматизацій
Відповідність вимогам compliance
Аудит, GDPR, архівування

Обмеження швидкості

Що рахується за API

Рахунок нараховується за кожен токен; без Bearer — за IP-адресою. Наведені нижче значення є задокументованими мінімальними значеннями, які діють у кожному тарифному плані.

5: Запитів за секунду
30: Запитів за хвилину
100: Запитів за годину
500: Запитів за день

Залишкові значення містяться у відповідному заголовку
Заголовки RateLimit-* та X-RateLimit-* кожної відповіді вказують, скільки залишилося у поточному вікні.
Перевищення: HTTP 429
API відповідає з кодом RATE_LIMIT_EXCEEDED. Повторіть запит після часу, вказаного у заголовку Retry-After.
Вищі тарифи підвищують ці значення
Платні тарифи перевищують ці мінімальні значення. Який тариф має який обсяг, вказано на сторінці цін.

Переглянути тарифи та обсяги

Безпека

Що захищає ключ

Шість механізмів, що діють у роботі — кожен з перевірним кодом стану або місцем у додатку.

Обертання та анулювання
Ключі створюються, відображаються, обертаються та анулюються в додатку за адресою Account → API. Анульований токен повертає HTTP 401 TOKEN_NOT_FOUND.
Термін дії та валідність
Токени, що закінчилися або є невірними, повертають HTTP 401 INVALID_TOKEN. Публічні ключі (Publishable Keys) дійсні не пізніше ніж протягом 365 днів.
Обмеження на токен
Ліміти швидкості (Rate-Limits) нараховуються на кожен токен, а не на кожен обліковий запис. Компроматований ключ не навантажує всю операційну діяльність.
Прив'язка до джерела в браузері
Публічні ключі (Publishable Keys) вимагають зазначення Origin у списку дозволених для кожного запиту; інакше повертається помилка API з кодом 403 ORIGIN_HEADER_REQUIRED або DOMAIN_NOT_ALLOWED.
Відстеження використання
Кожна оплачена відповідь містить блок _billing; аналіз на один виклик здійснюється через GET /latest/billing/usage-detail.
Жорсткі обмеження
Вхід у обліковий запис, керування ключами, OAuth, адміністрування партнерів, зміна платежів та зламування паролів заблоковано для браузерних ключів. Дозволено читання продукту APIs (включно з billing) та вебхуків. Видалення Workspace, очищення кошика та зняття Legal-Hold доступні лише в додатку (403 UI_ONLY_ENDPOINT).

Відео

Аутентифікація у дії

Подивіться, як працює виклик з Bearer-токеном на практиці — у відео.

Додатково

Що стоїть поруч

Сторінки, які охоплюють операційну діяльність навколо автентифікації.

Publishable Keys Дзвінки напряму з браузера за допомогою po_pk_. Вебхуки Отримання подій замість опитування. Postman-Колекція Усі кінцеві точки для навігації. API-Каталог Яка кінцева точка виконує яку роботу. llms-full.txt Повна документація для вашого IDE. Тарифи Який тариф який обсяг покриває.

Почати

Створити ключ, встановити заголовок, надіслати

Ключ створюється у додатку в розділі Обліковий запис → API. Перший виклик детально описано в кроках першого виклику API.

Створити ключ API Запустити перший виклик API

Експлуатація та довіра

Що перевіряють корпоративні команди перед першим дзвінком

Договори, безпека, підтримка та ліміти — все посилання в одному місці.

Наступна зупинка

Як продовжити

Рекомендований наступний крок у воронці розробників та два відповідні відгалуження.

Webhooks & EventsПодії в реальному часі, HMAC Перший виклик APIОтримати ключ, надіслати запит, перевірити відповідь Postman CollectionІмпорт, тестування, налагодження в Postman

Повернутися до входу для розробників

Зрозумійте PaperOffice AI за 14 хвилин.

Як ви хочете використовувати PaperOffice?