Web Services

Open-Capture intègre un catalogue de web services. Ces derniers sont utilisés par les différents scripts ainsi que par l'interface de l'application. Si vous le souhaitez, vous avez la possibilité de les utiliser afin de communiquer avec Open-Capture.

Les web services, de type REST, sont accessibles via l'URL suivante :

https://demo.open-capture.com/backend_oc/ws/

Vous retrouverez un exemple d'URL ci-dessous pour la consommation d'un web service récupérant tous les comptes fournisseurs :

https://demo.open-capture.com/backend_oc/ws/accounts/suppliers/list

Pour consommer les différents webservices il vous faudra créer un compte avec le mode de connexion Webservice. Ensuite, il faudra spécifier dans les Headers l'authorization Auth Basic. À noter qu'il vous sera aussi possible d'utiliser une authentification par Bearer Token. La génération d'un token est disponible dans les paramètres d'Open-Capture.

Exemple d'un appel webservice

import base64
import requests

url = 'https://demo.open-capture.com/backend_oc/ws/config/gitInfo'
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Basic ' + base64.b64encode(b'user_ws:user_ws').decode('UTF-8')
}
response = requests.get(url, headers=headers, timeout=5)

La liste des web service est exhaustives. Seul les plus importants sont mentionnés. Si besoin, vous pouvez nous contacter sur github ou alors fouillez dans les fichiers de routing présent dans le dossier /var/www/html/opencapture/src/backend/rest/