Aller au contenu principal
Fonctionne dans Claude · Vérifié par Anthropic
Aperçu Aperçu Actualités Actualités
Partager

Authentification et Clés

Un jeton Bearer. Chaque point de terminaison.

Chaque point de terminaison produit de PaperOffice-API attend l'en-tête Authorization: Bearer. Aucun flux OAuth, aucun renouvellement.

Deux types de jetons, droits clairs, limites de taux documentées.

Un en-tête Aucun flux OAuth Révocable à tout moment
Un jeton Bearer. Chaque point de terminaison.
cURL
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"

Premier appel

Définir l'en-tête, choisir la pipeline, soumettre

Le chemin après /latest/job/add/ est le nom de l'opération: généralement sous la forme handler___command (par exemple paperoffice_aiocr___generate), et pour les IDP structurés, le pipeline dédié workflow.

  • Un en-tête

    Authorization: Bearer po_ut_… — un point de terminaison produit n'a pas besoin de plus. poai_ et po_ut_ n'envoient pas d'en-tête Origin.

  • Pipeline dans le chemin

    handler___command avec trois underscores ; workflow est l'exception avec son propre slug. La notation par points répond à API avec HTTP 400 JOB_CONFIG_INVALID.

  • Résultat ou job_id

    client_wait est par défaut true : API maintient la connexion et renvoie le résultat en ligne. Si la fenêtre temporelle est insuffisante, HTTP 202 avec job_id et poll_url pour GET /latest/job/get/{job_id} est retourné.

Pour idp_collection=invoice, basic-pro-max est le modèle recommandé. Le modèle effectivement utilisé est renvoyé dans le champ de réponse model et peut différer de celui demandé.

Types de jetons

Deux types de jetons, clairement séparés

Les deux doivent être envoyés au serveur. Ils sont créés, rotatifs et révoqués dans l'application sous Compte → API.

poai_ Serveur à serveur

Clé API

  • Droits du compte qui la crée (admin : l'ensemble du compte)
  • Jamais livré dans le code du navigateur
  • Aucun en-tête Origin requis
  • Bloqué pour MCP
  • Peut être limitée à des adresses IP
Gérer les clés API
po_ut_ Lié à l'utilisateur

User Token

  • Apporte les droits de son utilisateur
  • Jamais livré dans le code du navigateur
  • Aucun en-tête Origin requis
  • Autorisé pour MCP
Créer un jeton utilisateur

Les appels directs depuis le navigateur ne passent pas par ces deux jetons, mais par la clé publishable po_pk_ — liée à l'origine, avec budget et limites de taux. Voir les clés publishable

Autorisations

Ce qu'un User Token peut faire

Un User Token dispose exactement des droits de son utilisateur dans ces domaines. Certains domaines ne peuvent pas être attribués lors de la création; pour les restreindre, un jeton de groupe (po_gt_) avec les droits d'un groupe d'utilisateurs est utilisé.

  • Documents documents

    Téléchargement, téléchargement, traitement

  • Workspaces workspaces

    Gérer les dossiers et la structure

  • Tâches IA ai_jobs

    OCR, IDP, Extraction

  • Facturation billing

    Lire l'utilisation et le solde du compte

  • Utilisateurs users

    Gérer les membres de l'équipe

  • Webhooks webhooks

    Recevoir des événements

  • Base de connaissances knowledge_base

    Base de connaissances et FAQ

  • Agents agents

    Configurer les agents IDP

  • Flux de travail workflows

    Créer des automatisations

  • Conformité compliance

    Audit, RGPD, archivage

Limites de taux

Ce que compte le API

La facturation se fait par token ; sans Bearer, par adresse IP. Les valeurs suivantes sont les minima documentés applicables à chaque tarif.

5
Requêtes par seconde
30
Requêtes par minute
100
Requêtes par heure
500
Requêtes par jour
  • Les valeurs restantes figurent dans l'en-tête de réponse

    Les en-têtes RateLimit-* et X-RateLimit-* de chaque réponse indiquent ce qui reste disponible dans la fenêtre actuelle.

  • Dépassement : HTTP 429

    L'erreur API renvoie RATE_LIMIT_EXCEEDED. Réessayez l'appel après le délai indiqué dans l'en-tête Retry-After.

  • Les tarifs supérieurs augmentent ces valeurs

    Les tarifs payants sont supérieurs à ces valeurs minimales. Le détail de l'étendue de chaque tarif figure sur la page des prix.

Sécurité

Ce qui sécurise une clé

Six mécanismes qui s'activent en production — chacun avec un code de statut vérifiable ou un emplacement dans l'application.

  • Rotation et révocation

    Les clés sont créées, listées, rotées et révoquées dans l'application sous Compte → API. Un token révoqué répond par HTTP 401 TOKEN_NOT_FOUND.

  • Expiration et validité

    Les jetons expirés répondent avec HTTP 401 BEARERTOKEN_EXPIRED, ceux erronés avec HTTP 401 INVALID_TOKEN. Publishable Keys sont valables 180 jours à compter de leur création.

  • Limites par token

    Dans l'offre Free, des limites de débit s'appliquent par jeton. Dans les offres payantes, le compte est pris en compte; tant que Credits sont disponibles, aucune limite de débit ne s'applique.

  • Liaison à l'origine dans le navigateur

    Les clés publishable exigent un Origin dans la liste autorisée pour chaque requête ; sinon, l'API répond 403 ORIGIN_HEADER_REQUIRED ou DOMAIN_NOT_ALLOWED.

  • Suivi de l'utilisation

    Chaque réponse facturée contient un bloc _billing ; l'évaluation par appel fournit GET /latest/billing/usage-detail.

  • Blocages stricts

    La connexion au compte, la gestion des clés, OAuth, l'administration des partenaires, la mutation de paiement et le crack de mot de passe sont bloqués pour les clés de navigateur. Le produit APIs incluant la lecture de facturation et les webhooks sont autorisés. La suppression de Workspace, le vidage de la corbeille et l'autorisation Legal-Hold ne sont possibles que dans l'application (403 UI_ONLY_ENDPOINT).

Commencer

Créer la clé, définir l'en-tête, envoyer

Vous créez la clé dans l'application sous Compte → API. Le premier appel est expliqué étape par étape dans le Premier appel API.

PaperOffice AI · Problem Solver

Racontez-nous, ce qui vous fait perdre du temps au quotidien.

Décrivez simplement. Aucun terme technique n'est nécessaire.

Ou commencez avec un exemple

Comment souhaitez-vous utiliser PaperOffice ?

Ordinateur et smartphone sont connectés : espace de travail sur l'ordinateur, capture sur le téléphone.

Où souhaitez-vous commencer ?

L'espace de travail complet est optimisé pour l'ordinateur. La version mobile convient pour capturer, vérifier et approuver des documents.

S’inscrire gratuitement app.paperoffice.ai

Commencer sur l'ordinateur

Nous vous envoyons votre lien d'accès personnel par e-mail.