Uwierzytelnianie i klucze

Token Bearer. Każdy punkt końcowy.

Każdy punkt końcowy produktu PaperOffice-API oczekuje nagłówka Authorization: Bearer. Bez przepływu OAuth, bez odświeżania.

Dwa typy tokenów, dziesięć zakresów uprawnień, udokumentowane limity szybkości.

Nowy klucz API Pierwsze wywołanie API

Jeden nagłówek Brak przepływu OAuth Możliwe cofnięcie w dowolnym momencie

app.paperoffice.ai/account/api

Żądanie 200 OK Token ważny

Nagłówek autoryzacji

Authorization: Bearer po_ut_YOUR_API_KEY

Uprawnienia

ocr:read
documents:write
jobs:read

Odpowiedź

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

Własna infrastruktura UE Państwa dane pozostają w Europie.
ISO 27001 aktywny Zaufanie certyfikowane.
SOC 2 Typ II aktywny Międzynarodowe standardy audytu.
Ponad 24 lata doświadczenia Sprawdzone. Stabilne. Bezpieczne dla przyszłości.

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());

Pierwsze wywołanie

Ustawienie nagłówka, wybór potoku, wysyłka

Ścieżka do /latest/job/add/ to nazwa zadania kolejki: zazwyczaj w formacie handler___command (np. paperoffice_aiocr___generate), dla strukturalnego IDP jest to własny workflow potoku.

Jeden nagłówek
Authorization: Bearer po_ut_… — więcej nie jest potrzebne dla punktu końcowego produktu. po_sk_ i po_ut_ nie wysyłają nagłówka Origin.
Potok w ścieżce
handler___command z trzema podkreśleniami; workflow jest wyjątkiem z własnym slugiem. Notacja kropek odpowiada na API kodem HTTP 400 JOB_CONFIG_INVALID.
Wynik lub job_id
client_wait jest domyślnie ustawione na true: API utrzymuje połączenie i zwraca wynik inline. Jeśli okno czasowe nie wystarczy, otrzymają Państwo HTTP 202 z job_id i poll_url do GET /latest/job/get/{job_id}.

Zobacz katalog API llms-full.txt dla Państwa IDE

Dla idp_collection=invoice zalecanym modelem jest basic-pro-max: OCR-first ogranicza drukowane kolekcje z pozycjami do basic-pro-max; wysłany model=premium zostanie zwrócony jako model: basic-pro-max.

Typy tokenów

Dwa typy tokenów, wyraźnie oddzielone

Oba należy umieścić na serwerze. Są tworzone, rotowane i cofane w aplikacji pod Konto → API.

po_sk_ Serwer do serwera

Klucz tajny

Pełny dostęp w ramach konta
Nigdy nie dostarczaj w kodzie przeglądarki
Nie wymaga nagłówka Origin
Zablokowane dla MCP

Zarządzanie kluczem tajnym

po_ut_ Powiązane z użytkownikiem

User Token

Może być ograniczone do poszczególnych obszarów
Nigdy nie dostarczaj w kodzie przeglądarki
Nie jest wymagany nagłówek Origin
Dozwolone dla MCP

Nowy token użytkownika

Wywołania bezpośrednio z przeglądarki nie przechodzą przez te dwa tokeny, lecz przez klucz publishable po_pk_ — powiązany z źródłem, z limitem budżetu i limitu żądań. Przegląd Publishable Keys

Uprawnienia

Dziesięć obszarów na token użytkownika

Token użytkownika zawiera dokładnie te obszary, które Państwo mu przypiszą podczas tworzenia. Brak obszaru powoduje odpowiedź API z HTTP 403.

Dokumenty dokumenty
Przesyłanie, Pobieranie, Przetwarzanie
Workspaces przestrzenie robocze
Zarządzanie folderami i strukturą
Zadania AI zadania_ai
OCR, IDP, Ekstrakcja
Rozliczenie faktury
Odczyt użycia i salda konta
Użytkownicy użytkownicy
Zarządzaj członkami zespołu
Webhooki webhooki
Odbieraj zdarzenia
Baza wiedzy baza_wiedzy
Baza wiedzy i FAQ
Agenci agenci
Konfiguruj agentów IDP
Workflowy workflowy
Twórz automatyzacje
Zgodność zgodność
Audyt, RODO, archiwizacja

Ograniczenia szybkości

Co liczy się w API

Rozliczane jest za każdy token; bez Bearera według adresu IP. Poniższe wartości to udokumentowane minimalne wartości obowiązujące w każdym taryfie.

5: Zapytania na sekundę
30: Zapytania na minutę
100: Zapytania na godzinę
500: Zapytania na dzień

Pozostałe wartości znajdują się w nagłówku odpowiedzi
Nagłówki RateLimit-* i X-RateLimit-* każdej odpowiedzi informują, ile pozostało w bieżącym oknie czasowym.
Przekroczenie: HTTP 429
API odpowiada kodem RATE_LIMIT_EXCEEDED. Proszę powtórzyć wywołanie po czasie podanym w nagłówku Retry-After.
Wyższe taryfy podnoszą wartości
Płatne taryfy znajdują się powyżej tych wartości minimalnych. Zakres poszczególnych taryf znajduje się na stronie cenowej.

Taryfy i zakres

Bezpieczeństwo

Co chroni klucz

Sześć mechanizmów działających w eksploatacji — każdy z weryfikowalnym kodem statusu lub lokalizacją w aplikacji.

Rotacja i unieważnienie
Klucze są tworzone, wyświetlane, rotowane i unieważniane w aplikacji pod ścieżką Konto → API. Unieważniony token zwraca odpowiedź HTTP 401 TOKEN_NOT_FOUND.
Ważność i termin ważności
Wygasłe lub błędne tokeny zwracają HTTP 401 INVALID_TOKEN. Klucze publikowalne wygasają najpóźniej po 365 dniach.
Limity na token
Limity szybkości są liczone na token, a nie na konto. Skompromitowany klucz obciąża tym samym cały operat.
Powiązanie z pochodzeniem w przeglądarce
Klucze publikowalne wymagają przy każdym zapytaniu nagłówka Origin z listy dozwolonych; w przeciwnym razie API odpowiada 403 ORIGIN_HEADER_REQUIRED lub DOMAIN_NOT_ALLOWED.
Śledzenie użycia
Każda rozliczona odpowiedź zawiera blok _billing; ocena na wywołanie daje GET /latest/billing/usage-detail.
Sztywne blokady
Logowanie do konta, zarządzanie kluczami, OAuth, administrowanie partnerami, modyfikacje płatności i łamanie haseł są zablokowane dla kluczy przeglądarkowych. Produkt APIs wraz z odczytem rozliczeń i webhookami jest dozwolony. Usuwanie Workspace, opróżnianie kosza i zwalnianie holdu prawnego możliwe tylko w aplikacji (403 UI_ONLY_ENDPOINT).

Wideo

Uwierzytelnianie w praktyce

Proszę zobaczyć w filmie, jak wygląda wywołanie z tokenem Bearer w praktyce.

Dalsze informacje

Co jest obok

Strony obsługujące operacje wokół uwierzytelniania.

Publishable Keys Wywołania bezpośrednio z przeglądarki za pomocą po_pk_. Webhooki Odbieranie zdarzeń zamiast pollowania. Postman-Kolekcja Wszystkie punkty końcowe do przeglądania. Katalog API Który punkt końcowy wykonuje jaką pracę. llms-full.txt Cała dokumentacja dla Państwa IDE. Taryfy Jaka taryfa jaki zakres obejmuje.

Start

Utworzenie klucza, ustawienie nagłówka, wysyłka

Klucz utworzą Państwo w aplikacji w zakładce Konto → API. Pierwsze wywołanie krok po kroku znajdą Państwo w przewodniku Pierwsze wywołanie API.

Nowy klucz API Pierwsze wywołanie API

Eksploatacja i zaufanie

Co zespoły enterprise sprawdzają przed pierwszym połączeniem

Umowy, bezpieczeństwo, wsparcie i limity – wszystko w jednym miejscu.

Następny przystanek

Jak dalej

Zalecany następny krok w lejku deweloperskim i dwa odpowiednie odgałęzienia.

Webhooks & EventsZdarzenia w czasie rzeczywistym, HMAC Pierwsze wywołanie APIPobierz klucz, wyślij żądanie, sprawdź odpowiedź Postman CollectionImportuj, testuj, debuguj w Postman

Powrót do wejścia deweloperskiego

PaperOffice AI w 15 minut.

Jak chcieliby Państwo korzystać z PaperOffice?