Documentation Frappe Framework
Frappe Framework
Intégration : API REST
Ce chapitre explique comment utiliser l’API REST de Frappe : authentification simple, par jeton ou OAuth 2, listing et manipulation des documents.
Contenu du chapitre
Ce chapitre explique comment utiliser l’API REST de Frappe : authentification simple, par jeton ou OAuth 2, listing et manipulation des documents.
Pages de ce chapitre, dans l’ordre de la documentation officielle :
Dans ce chapitre
- 01Introduction à l’API RESTL’API sert à appeler une méthode en liste blanche ou à créer, lire, modifier et supprimer un document. La version 2 ajoute copie, comptage et métadonnées.
- 02Authentification simpleLa connexion par identifiant et mot de passe renvoie un cookie sid. Les appels suivants le renvoient pour rester authentifiés.
- 03Authentification par jeton (token)Chaque requête porte la clé d’API et le secret, en token ou en Basic. Un jeton OAuth 2 s’envoie en Bearer. Les droits sont ceux de l’utilisateur choisi.
- 04OAuth 2authorize, get_token, revoke, profil OpenID et introspection. Le jeton d’identité est un JWT signé HS256 avec le secret du client.
- 05Lister les documentsUne requête GET sur /api/resource/{doctype} renvoie les documents par pages. Par défaut, seul le nom est inclus.
- 06Manipuler les documentsCinq routes couvrent la liste, la création, la lecture, la mise à jour partielle et la suppression. La liste est paginée par 20 et ne renvoie que le nom.