31,003
edits
Module Web Services API REST (développeur): Difference between revisions
Jump to navigation
Jump to search
m
Module Web Services API REST (développeur) (view source)
Revision as of 17:43, 1 April 2020
, 6 years agono edit summary
m (→Exemples) Tag: 2017 source edit |
mNo edit summary Tag: 2017 source edit |
||
| Line 42: | Line 42: | ||
Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl. | Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl. | ||
= Installation = | = Installation = | ||
| Line 299: | Line 289: | ||
* on récupère l'id du client dans $clientDoliId | * on récupère l'id du client dans $clientDoliId | ||
= | |||
= Développer un nouveau service / sa propre API = | |||
Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/monmodule/class'''. | |||
Si vous utilisez le "modulebuilder" pour développer sur Dolibarr, cette API avec les méthode CRUD pourra même être générée pour vous. | |||
Sinon, un copié-collé d'un fichier API existant fera l'affaire. Vous pouvez prendre comme exemple le fichier dans '''htdocs/commande/class/api_orders.class.php''' et l'adapté à votre classe / besoin. | |||
Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur. | |||
Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/monmodule/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe. | |||
Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md | |||
Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php'''<br/> | Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php'''<br/> | ||