poai_ Сервър към сървър API ключ
- Правата на акаунта, който го създава (админ: целият акаунт)
- Никога да не се доставя в браузърски код
- Не е необходим Origin заглавка
- Блокирано за MCP
- Може да бъде ограничен до IP адреси
Автентикация и ключове
Bearer токен. Всеки крайна точка.
Всяка крайна точка на продукта на PaperOffice-API изисква заглавката Authorization: Bearer. Без OAuth поток, без обновяване.
Два типа токени, ясни права, документирани лимити на честотата.
Едно заглавие Няма OAuth поток Може да бъде отменен по всяко време
- Собствена инфраструктура в ЕС Вашите данни остават в Европа.
- ISO/IEC 27001 (сертифициран) Сигурността е сертифицирана.
- 24+ години опит Доказано. Стабилно. Бъдеще-ориентирано.
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \ -H "Authorization: Bearer po_ut_YOUR_API_KEY" \ -F "file_1=@invoice.pdf" \ -F "idp_collection=invoice" \ -F "model=basic-pro-max"import requestsresponse = requests.post( "https://api.paperoffice.ai/latest/job/add/workflow", headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"}, files={"file_1": open("invoice.pdf", "rb")}, data={"idp_collection": "invoice", "model": "basic-pro-max"},)print(response.json())const form = new FormData();form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");form.append("idp_collection", "invoice");form.append("model", "basic-pro-max");const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", { method: "POST", headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" }, body: form,});console.log(await response.json());Първо извикване
Задайте заглавка, изберете тръбопровод, изпратете
Пътят след /latest/job/add/ е името на операцията: обикновено във формат handler___command (например paperoffice_aiocr___generate), а за структуриран IDP е workflow.
- Една заглавка
Authorization: Bearer po_ut_… — това е всичко, от което се нуждае един продуктов endpoint. poai_ и 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}.
За idp_collection=invoice се препоръчва моделът basic-pro-max. Всъщност използваният модел се връща в отговорното поле "model" и може да се различава от заявения.
Типове токени
Два типа токени, ясно разделени
И двата се изпращат към сървъра. Създават се, ротират и се отзовават в приложението под Account → API.
po_ut_ Потребителско User Token
- Носи правата на своя потребител
- Никога да не се доставя в браузърски код
- Не е необходим Origin заглавка
- Разрешено за MCP
Заявките, изпращани директно от браузъра, не минават през тези два токена, а чрез Publishable Key po_pk_ — привързан към произхода, с бюджет и ограничение на честотата. Преглед на Publishable Keys
Разрешения
Какво може да прави User Token
User Token има точно правата на своя потребител в тези области. Отделни области не могат да бъдат присвоени при създаване; за ограничаване се използва групов токен (po_gt_) с правата на потребителска група.
- Документи
documentsКачване, изтегляне, обработка
- Workspaces
workspacesУправление на папки и структура
- AI задачи
ai_jobsOCR, IDP, извличане
- Фактуриране
billingПрочитане на използване и баланс на акаунта
- Потребители
usersУправление на членовете на екипа
- Уебхукове
webhooksПолучаване на събития
- База знания
knowledge_baseБаза данни за знания и често задавани въпроси
- Агенти
agentsКонфигуриране на IDP агенти
- Работни процеси
workflowsСъздаване на автоматизации
- Съответствие
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 BEARERTOKEN_EXPIRED, а невалидните с HTTP 401 INVALID_TOKEN. Publishable Keys са валидни 180 дни от създаването.
- Лимити на токен
В тарифа Free важат лимити за честота на заявките (rate-limits) на токен. В платените тарифи се брои акаунтът; докато има налични Credits, там не се прилагат лимити за честота.
- Връзка с произхода в браузъра
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).
Старт
Създайте ключ, задайте заглавие, изпратете
Поставяте ключа в приложението под Account → API. Първото обаждане е описано стъпка по стъпка в първия API-Call.
Експлоатация и доверие
Какво екипите на предприятията проверяват преди първия разговор
Договори, сигурност, поддръжка и лимити, всичко свързано на едно място.
- Сигурност и съответствие ISO/IEC 27001 (сертифициран), собствена инфраструктура в ЕС.
- СЛА 99,9 % Наличност за всеки календарен месец, договорно гарантирана.
- Обработка на данни от име (DPA) Договор за обработка на данни съгласно чл. 28 от GDPR.
- Без субпроцесори Един доставчик за двигател, съхранение и обработка.
- Техническа поддръжка Директен път до екипа за поддръжка чрез тикет.
- Лимити на честотата и заглавки Документирани минимални стойности за всеки токен, заглавки за лимит на честотата в всеки отговор.
- Цени и Credits Прозрачни цени на Credits за всяко обаждане.
Следваща спирка
Какво следва
Препоръчителната следваща стъпка във фунията за разработчици и две подходящи разклонения.
