Saltar al contenido
Resumen Resumen Noticias Noticias
Compartir

Autenticación y claves

Un token Bearer. Cada punto final.

Cada punto final del producto PaperOffice-API espera el encabezado Authorization: Bearer. Sin flujo OAuth, sin actualización.

Dos tipos de token, diez ámbitos de autorización, límites de frecuencia documentados.

Un encabezado Sin flujo OAuth Revocable en cualquier momento
cURL
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \  -H "Authorization: Bearer po_ut_YOUR_API_KEY" \  -F "[email protected]" \  -F "idp_collection=invoice" \  -F "model=basic-pro-max"

Primera llamada

Establecer encabezado, elegir pipeline, enviar

La ruta hacia /latest/job/add/ es el nombre del trabajo de cola: generalmente en la forma handler___command (por ejemplo, paperoffice_aiocr___generate); para IDP estructurado, se utiliza el workflow propio de la pipeline.

  • Un encabezado

    Authorization: Bearer po_ut_… — un punto final de producto no necesita más. po_sk_ y po_ut_ no envían el encabezado Origin.

  • Pipeline en la ruta

    handler___command con tres guiones bajos; workflow es la excepción con su propio slug. La notación de puntos responde a API con HTTP 400 JOB_CONFIG_INVALID.

  • Resultado o job_id

    client_wait es true por defecto: API mantiene la conexión y entrega el resultado en línea. Si el intervalo de tiempo no es suficiente, se devuelve HTTP 202 con job_id y poll_url para GET /latest/job/get/{job_id}.

Para idp_collection=invoice, basic-pro-max es el modelo recomendado: OCR-first limita las colecciones impresas con posiciones de todos modos a basic-pro-max; un model=premium enviado se devuelve como model: basic-pro-max.

Tipos de token

Dos tipos de tokens, claramente separados

Ambos deben enviarse al servidor. Se crean, rotan y revocan en la aplicación bajo Cuenta → API.

po_sk_ Servidor a Servidor

Clave secreta

  • Acceso completo dentro del marco de la cuenta
  • Nunca entregar en código del navegador
  • Sin necesidad de encabezado Origin
  • Bloqueado para MCP
Gestionar clave secreta
po_ut_ Relacionado con el usuario

User Token

  • Limitable a áreas individuales
  • Nunca entregar en código del navegador
  • No se requiere encabezado de origen
  • Aprobado para MCP
Crear token de usuario

Las llamadas directas desde el navegador no pasan por estos dos tokens, sino por la clave publicable po_pk_, vinculada al origen, con límite de presupuesto y tasa. Ver claves publicables

Permisos

Diez áreas por token de usuario

Un token de usuario contiene exactamente las áreas que usted le asigna al crearlo. Si falta el área, la respuesta será API con HTTP 403.

  • Documentos documentos

    Subir, Descargar, Procesamiento

  • Workspaces espacios_de_trabajo

    Gestionar carpetas y estructura

  • Trabajos de IA trabajos_ai

    OCR, IDP, Extracción

  • Facturación facturación

    Leer uso y saldo de la cuenta

  • Usuarios usuarios

    Gestionar miembros del equipo

  • Webhooks webhooks

    Empfangen von Ereignissen

  • Wissensdatenbank base_conocimiento

    Base de conocimientos y preguntas frecuentes

  • Agentes agentes

    Configurar agentes IDP

  • Flujos de trabajo flujos_de_trabajo

    Crear automatizaciones

  • Cumplimiento normativo cumplimiento

    Auditoría, RGPD, archivado

Límites de frecuencia

Lo que cuenta API

Se cobra por token; sin Bearer por dirección IP. Los siguientes valores son los mínimos documentados que aplican en cada tarifa.

5
Solicitudes por segundo
30
Solicitudes por minuto
100
Solicitudes por hora
500
Solicitudes por día
  • Los valores restantes se encuentran en el encabezado de respuesta

    Los encabezados RateLimit-* y X-RateLimit-* de cada respuesta indican cuánto queda disponible en la ventana actual.

  • Exceso: HTTP 429

    La API responde con RATE_LIMIT_EXCEEDED. Repita la llamada después del tiempo indicado en el encabezado Retry-After.

  • Las tarifas superiores aumentan los valores

    Las tarifas pagadas están por encima de estos valores mínimos. Qué plan tiene qué alcance se indica en la página de precios.

Seguridad

Qué protege una clave

Seis mecanismos que entran en acción durante la operación, cada uno con un código de estado verificable o una ubicación en la aplicación.

  • Rotación y revocación

    Las claves se crean, listan, rotan y revocan en la aplicación bajo Cuenta → API. Un token revocado responde con HTTP 401 TOKEN_NOT_FOUND.

  • Vencimiento y validez

    Los tokens vencidos o erróneos devuelven HTTP 401 INVALID_TOKEN. Las claves publicables caducan como máximo a los 365 días.

  • Límites por token

    Los límites de velocidad se cuentan por token, no por cuenta. Una clave comprometida no afecta a toda la operación.

  • Vinculación del origen en el navegador

    Las claves publicables requieren un Origin en la lista permitida con cada solicitud; de lo contrario, la API responde con 403 ORIGIN_HEADER_REQUIRED o DOMAIN_NOT_ALLOWED.

  • Rastrear el uso

    Cada respuesta facturada incluye un bloque _billing; la evaluación por llamada proporciona GET /latest/billing/usage-detail.

  • Bloqueos estrictos

    El inicio de sesión de cuenta, la gestión de claves, OAuth, el administrador de socios, la mutación de pagos y el crackeo de contraseñas están bloqueados para las claves del navegador. Se permiten los productos APIs, incluida la lectura de facturación y los webhooks. La eliminación de Workspace, el vaciado del papelera y la liberación de retención legal solo se pueden realizar en la aplicación (403 UI_ONLY_ENDPOINT).

Vídeo

Autenticación en acción

Vea cómo funciona una llamada con token Bearer en la práctica — en el vídeo.

Autenticación en acción

Comenzar

Crear clave, configurar encabezado, enviar

Puede crear la clave en la aplicación bajo Cuenta → API. La primera llamada se describe paso a paso en la Primera llamada API.

¿Dónde desea probar PaperOffice?

Ordenador y smartphone conectados: espacio de trabajo en el ordenador, captura en el teléfono.

Su versión de prueba está lista

¿Dónde desea comenzar?

El espacio de trabajo completo está optimizado para el ordenador. La versión móvil es adecuada para capturar, revisar y aprobar documentos.

app.paperoffice.ai

Comenzar en el ordenador

Le enviaremos su enlace de acceso personal a su dirección de correo electrónico.

Registrarse gratis Abrir aplicación Aplicación PaperOffice El producto completo: web, escritorio y móvil. Capture, organice, busque y trabaje en documentos con su equipo. Se requiere una cuenta gratuita Abrir Playground Playground Pruebe funciones seleccionadas de inmediato — con una clave API de demostración restringida. Con una clave API de demostración restringida