Dokos

API

Consulter la référence interactive de l'API REST de Dokos : types de document et méthodes des modules de gestion.

Cette page affiche la référence interactive de l'API REST de Dokos. Elle couvre les modules de gestion : comptabilité, CRM, achats, ventes, stock, projets, production, immobilisations, qualité et les autres modules de l'application.

Pour les types de document du framework (utilisateurs, fichiers, e-mails…), voir Ressources. Pour la présentation de Dokos, voir Bienvenue sur Dokos.

Ce que contient la référence

La référence est générée par le site de démonstration à partir du code de l'application. 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 : elles sont lues et écrites avec leur document parent.
  • /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. Utilisez le champ de filtre pour chercher un point d'accès.

S'authentifier

Chaque appel s'authentifie avec les clés d'API d'un utilisateur, dans l'en-tête Authorization: token <api_key>:<api_secret>. L'API applique les droits de cet utilisateur. Pour générer les clés et connaître les principes de l'API, voir API Rest et API REST v2.

Exemple fictif

La société Mappemonde lit le nom et le groupe de ses clients :

curl -G "https://mappemonde.example.com/api/resource/Customer" \
  -H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
  --data-urlencode 'fields=["name", "customer_group"]' \
  --data-urlencode 'limit_page_length=20'