Metadata-Version: 2.4
Name: docoki-sdk
Version: 0.2.0
Summary: Client serveur Python de l’API Docoki
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# SDK Python Docoki 0.2.0

Déposez vos documents, estimez leur consommation, lancez vos traitements et téléchargez vos résultats depuis votre application. Utilisez Python 3.11 ou supérieur.

Installez l’archive téléchargée dans Développeurs → Tutoriel SDK :

    python -m pip install ./docoki_sdk-0.2.0-py3-none-any.whl

Créez une clé dédiée, choisissez ses droits et conservez-la dans votre gestionnaire de secrets. Pour cet exemple, accordez usage:read. Renseignez l’adresse HTTPS de votre API et l’identifiant de votre espace. Utilisez ce client dans une application de confiance, hors d’une page web publique.

    import os
    from docoki_sdk import Docoki, DocokiError
    client = Docoki(
        base_url=os.environ["DOCOKI_API_URL"],
        api_key=os.environ["DOCOKI_API_KEY"],
        workspace_id=os.environ["DOCOKI_WORKSPACE_ID"],
    )
    print(client.usage())

Les principales méthodes sont upload_parts, create_job, wait_for_job, download_asset, download_archive, usage, cancel_job, verify_webhook. Le tutoriel dans Docoki fournit un PDF d’essai et un exemple complet avec reprise après interruption. La référence OpenAPI 1.0.0 décrit les paramètres et réponses.

Conservez l’identifiant du dépôt avant l’envoi. Avant de lancer un traitement, conservez la demande et sa clé d’idempotence. Après une réponse incertaine, réutilisez exactement ces valeurs pour retrouver le traitement accepté sans second débit. Les lancements ne sont pas répétés automatiquement.

Le suivi attend au plus trois minutes par défaut ; cette durée est configurable. Arrêter le suivi n’annule pas le traitement. Demandez explicitement son annulation si nécessaire. Les appels attendent trente secondes par défaut. Les fichiers en entrée sont limités à 100 Mio et les téléchargements à 250 Mio par défaut ; respectez aussi les limites de chaque opération.

Le SDK vérifie la taille et l’empreinte des fichiers téléchargés. Il utilise HTTPS et refuse les redirections. Votre clé n’accompagne jamais les liens temporaires d’envoi. Une connexion HTTP doit être autorisée explicitement pour un essai dans un environnement contrôlé.

DocokiError fournit le code, le statut, l’identifiant de requête et le délai de reprise. N’enregistrez ni les clés, ni les mots de passe, ni les fichiers ou liens temporaires dans vos journaux. Une clé expirée ou révoquée doit être remplacée depuis votre session Docoki.

Pour les webhooks, vérifiez la signature sur le corps brut avant de lire le contenu, acceptez une fenêtre de cinq minutes et conservez les identifiants d’événement pendant trente jours pour éviter les doublons. Répondez en 2xx après la réception, y compris pour un événement déjà traité.
