Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Développeurs
API
API de documents
Lire, créer et modifier des documents en Python avec frappe.get_doc, frappe.read_doc et les autres méthodes de l'API de documents.
API Base de données
Lire et modifier les données en Python avec frappe.db.get_list et les autres méthodes de l'API base de données.
API REST v2
Référence des points d'accès /api/v2 : documents, méthodes, métadonnées, comptage et opérations en masse, avec le format des réponses.
API Rest
Accéder aux types de documents et aux méthodes whitelistées par l'API REST, avec une authentification par mot de passe ou par jeton.
API Jinja
Formater des valeurs, des dates et des URL et lire des documents dans les modèles Jinja avec les méthodes fournies par Dodock.
Génération d'images de prévisualisation
Dodock permet de générer des images de prévisualisation (captures d'écran) à partir de HTML ou d'une URL, en réutilisant le Chromium intégré au framework — sans dépendance externe.
Ressources
Consulter la référence interactive de l'API REST de Dodock, avec ses points d'accès, leurs paramètres et leurs réponses.
Temps réel (WebSocket / Socket.IO)
Comment utiliser et étendre le serveur Socket.IO Python de Dodock pour envoyer des événements en temps réel et définir des handlers personnalisés dans votre application.
Exemples
Exemples complets d'appels à l'API REST : réservation de ressource, commande client avec facture et paiement, contacts d'un client.
API Controller.docs — Accès statique aux documents
Utilisez les collections Controller.docs pour manipuler vos documents Doctype directement depuis leur classe Python, sans passer par les fonctions génériques de frappe.
Décorateur @rate_limit
Limiter le nombre d'appels à une fonction ou une route API avec le décorateur @rate_limit de Dodock
Filtres et requêtes avancés
Utiliser les opérateurs de filtre avancés de Dodock, dont between, pour interroger des dates, des heures et des nombres.