API

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.

Cette référence interactive liste les points d'accès de l'API REST de Dodock, avec leurs paramètres et leurs réponses. Elle couvre les types de document et les méthodes du framework : utilisateurs, rôles, fichiers, e-mails, impression, site web, intégrations… Pour les types de document de gestion (clients, factures, stock…), voir API de Dokos.

La référence est générée par le site de démonstration à partir du code. Elle contient deux familles de points d'accès :

  • /api/resource/<Type de document> : lister, créer, lire, modifier et supprimer les documents d'un type. Les tables enfants n'ont pas de point d'accès propre.
  • /api/method/<chemin.de.la.méthode> : appeler une méthode Python ouverte à l'API (décorée par @frappe.whitelist).

La référence est en lecture seule : les boutons Authorize et Try it out sont masqués. Pour l'authentification et les principes de l'API, voir API Rest et API REST v2. Pour des appels complets, voir les exemples.