6
edits
Module Web Services API REST (développeur): Difference between revisions
Jump to navigation
Jump to search
Module Web Services API REST (développeur) (view source)
Revision as of 19:18, 23 May 2017
, 9 years agoajout premiers paragraphes depuis version anglaise
(corrections diverses) |
(ajout premiers paragraphes depuis version anglaise) |
||
| Line 1: | Line 1: | ||
{{TemplateDocDevEn}} | |||
{{TemplateModEN}} | |||
[[Category:List of Modules]] | |||
{{BasculeDevUserEn| | |||
name=Web services| | |||
num=2610| | |||
devdoc=Cette page| | |||
userdoc=Non applicable|}} | |||
= Fonction = | |||
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr. | |||
= Seveur de Web services REST Dolibarr = | |||
Une fois que le module webservices REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requetes sur l'url relative : | |||
'''/api/index.php''' | |||
= Liste des services fournis = | |||
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse : | |||
'''http://yourdolibarrurl/api/index.php/explorer'''. | |||
Vous devez au préalable faire un premier appel au service '''login''' pour obtenir une clé API. | |||
Vous entrez alors la clé pour obtenir la liste des services proposés | |||
Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante : | |||
'''https://demo.dolibarr.org/api/index.php/explorer''' | |||
= Ajouter un nouveau service = | |||
Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/module/class'''. | |||
Vous trouverez des exemples dans '''htdocs/commande/class/api_orders.class.php''' | |||
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/module/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 | |||
= Installation = | = Installation = | ||