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

Bearer токен. Всеки крайна точка.

Всяка крайна точка на продукта на PaperOffice-API изисква заглавката Authorization: Bearer. Без OAuth поток, без обновяване.

Два типа токени, десет обхвата на разрешения, документирани лимити за честота на заявките.

Създаване на API-ключ Стартиране на първото API извикване

Едно заглавие Няма OAuth поток Може да бъде отменен по всяко време

app.paperoffice.ai/account/api

Заявка 200 OK Токенът е валиден

Authorization заглавка

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/ е името на jobs в опашката: обикновено във формата handler___command (например paperoffice_aiocr___generate), за структуриран IDP е собственият workflow на вашия pipeline.

Една заглавка
Authorization: Bearer po_ut_… — това е всичко, от което се нуждае един продуктов endpoint. po_sk_ и po_ut_ не изпращат Origin заглавка.
Pipeline в пътя
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; изпратеният model=premium се връща като model: basic-pro-max.

Типове токени

Два типа токени, ясно разделени

И двата се изпращат към сървъра. Създават се, ротират и се отзовават в приложението под Account → API.

po_sk_ Сервър към сървър

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

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

Управление на тайния ключ

po_ut_ Потребителско

User Token

Може да се ограничи до отделни области
Никога да не се доставя в браузърски код
Не е необходим Origin заглавка
Разрешено за MCP

Създаване на потребителски токен

Заявките, изпращани директно от браузъра, не минават през тези два токена, а чрез Publishable Key po_pk_ — привързан към произхода, с бюджет и ограничение на честотата. Преглед на Publishable Keys

Разрешения

Десет области за всеки потребителски токен

Потребителският токен носи точно онези области, които сте му присвоили при създаването. Ако липсва област, API ще отговори с HTTP 403.

Документи документи
Качване, изтегляне, обработка
Workspaces работни пространства
Управление на папки и структура
AI задачи ai_jobs
OCR, IDP, извличане
Фактуриране billing
Прочитане на използване и баланс на акаунта
Потребители потребители
Управление на членовете на екипа
Уебхукове уебхукове
Получаване на събития
База знания база_данни_за_знания
База данни за знания и често задавани въпроси
Агенти агенти
Конфигуриране на IDP агенти
Работни процеси работни потоци
Създаване на автоматизации
Съответствие съответствие
Аудит, 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 дни.
Лимити на токен
Лимитите за честота се броят на токен, а не на акаунт. Компромитиран ключ не натоварва цялата операция.
Връзка с произхода в браузъра
Publishable Keys изискват Origin от allowlist при всяка заявка; в противен случай се връща грешка API с код 403 ORIGIN_HEADER_REQUIRED или DOMAIN_NOT_ALLOWED.
Проследяване на използването
Всяка фактурирана отговорност съдържа _billing блок; оценката на всяка заявка предоставя GET /latest/billing/usage-detail.
Твърди блокировки
Вход в акаунт, управление с ключове, OAuth, администратор на партньори, промяна на плащания и взлом на пароли са блокирани за браузърски ключове. Продуктът APIs включва разрешено четене на фактуриране и уебхукове. Изтриването на Workspace, изпразването на кошчето и освобождаването на правната задължителност се извършват само в приложението (403 UI_ONLY_ENDPOINT).

Видео

Автентикация в действие

Вижте как работи извикване с Bearer-token в практиката — във видеото.

Допълнително

Какво е обърнато

Страниците, които покриват операциите около автентикацията.

Publishable Keys Извиквания директно от браузъра с po_pk_. Уебхукове Получаване на събития вместо polling. Postman-Колекция Всички крайни точки за навигация. API-Каталог Коя крайна точка каква работа изпълнява. llms-full.txt Цялата документация за вашата IDE. Тарифи Какъв обхват носи кой тариф.

Старт

Създайте ключ, задайте заглавие, изпратете

Поставяте ключа в приложението под Account → API. Първото обаждане е описано стъпка по стъпка в първия API-Call.

Създаване на API-ключ Стартиране на първото API извикване

Експлоатация и доверие

Какво екипите на предприятията проверяват преди първия разговор

Договори, сигурност, поддръжка и лимити, всичко свързано на едно място.

Следваща спирка

Какво следва

Препоръчителната следваща стъпка във фунията за разработчици и две подходящи разклонения.

Webhooks & EventsСъбития в реално време, HMAC Първо API извикванеВземете ключа, изпратете заявката, проверете отговора Postman CollectionИмпортиране, тестване и отстраняване на грешки в Postman

Назад към началото за разработчици

Разберете PaperOffice AI за 14 минути.

Как желаете да използвате PaperOffice?