Ce service propose une interface de développement REST et oAuth2 afin que les développeurs et organisations tiers puissent créer des produits qui interagissent avec le BOS SpinalCore.

Pour installer le serveur d'API il est nécessaire d'avoir la configuration suivante :

1. Assurez-vous que votre installation SpinalCore et que les extensions associées soient les dernières versions prises en charge. (Installer votre système )

2. Nodejs + npm installé sur votre distribution linux

3. PM2 (process manager) installer globalement sur votre serveur ou machine virtuelle. (Installer votre système )

Une fois le système SpinalCore installé, veuillez suivre la procédure suivante :

Installation :

Contacter Spinalcom pour avoir accès au dépôt du serveur d'API (Ce dépôt n'est pas encore en accès libre).

Configuration :

Dans le fichier de configuration du BOS : spinal-api-gateway/config.js

Les configurations à modifier dans le fichier sont :

spinalConnector: { user: process.env.SPINAL_USER_ID || 168, // user id password: process.env.SPINAL_PASSWORD || "3HNvC6fftqHz", // user password host: process.env.SPINALHUB_IP || "localhost", // can be an ip address port: process.env.SPINALHUB_PORT || 8080 // port } file: { // path to a digital twin in spinalhub filesystem path: process.env.SPINAL_DTWIN_PATH || '/__users__/admin/Digital_twin', }

Dans le fichier de configuration de spinal-api-gateway : spinal-api-gateway/config/gateway.config.yml

Les configurations à modifier dans le fichier sont :

http:

port: 8000

admin:

port: 9889

host: localhost

apiEndpoints:

apiDocs:

paths:

- /api-docs

host: '*'

admin:

paths:

- /admin

host: '*'

serviceEndpoints:

local:

url: 'http://localhost:3000'

policies:

- basic-auth

- cors

- expression

- key-auth

- log

- oauth2

- proxy

- rate-limit

pipelines: null

Lancer le système :

Positionnez-vous dans le répertoire contenant les modules du système d'information via la console :

spinalcom-system $> pm2 start launch.config.json

Démarrage :

Positionnez-vous dans le répertoire spinal-api-gateway via la console :

spinal-api-gateway $> npm run dev

L'usage du serveur d'API est décrit dans les ressources développeurs