# Documentation API

L'API DDB est composée d'un certain nombre de microservices différents. Vous trouverez ci-dessous les différents services avec lesquels vous pouvez interagir, ainsi que comment s'authentifier et accéder.

# Microservices

Notre API est séparée en *6 microservices *.

Microservice But
Service de contexte environnemental Le service de contexte environnemental stocke les données actuelles des projets utilisés dans DDB.
Service de paramètres Un service fournissant des informations sur les actifs et les paramètres sur les projets.
Service de métadonnées des paramètres Un service fournissant des métadonnées sur les actifs et les paramètres sur les projets.
Service de données de référence Informations sur les données source utilisées pour définir les références aux sources internes et externes.
Service de QA Hôte des données de service QA.
Service de commentaires Le service de commentaires est destiné à héberger des commentaires filetés liés à une variété de systèmes, d'actifs et de paramètres.

Chaque microservice a une instance indépendante pour chacun des trois environnements. Pour un récapitulatif du but de chaque environnement, voir ici .

Le tableau suivant comprend des liens vers chaque microservice, pour chaque environnement.

Microservice *Développement bac à sable Production
Service de contexte environnemental environnement_context_service (opens new window) environnement_context_service (opens new window) environnement_context_service (opens new window)
Service de paramètres paramètre_service (opens new window) paramètre_service (opens new window) paramètre_service (opens new window)
Service de métadonnées des paramètres paramètre_metadata_service (opens new window) paramètre_metadata_service (opens new window) paramètre_metadata_service (opens new window)
Service de données de référence référence_data_service (opens new window) référence_data_service (opens new window) référence_data_service (opens new window)
Service d'AQ QA_SERVICE (opens new window) QA_SERVICE (opens new window) QA_SERVICE (opens new window)
Service de commentaires commentaire_service (opens new window) commentaire_service (opens new window) commentaire_service (opens new window)

* Seule l'équipe de développement DDB devrait utiliser l'environnement de développement

Tous les différents services utilisent la même URL de base (par exemplehttps://ddb.arup.com (opens new window)) et sont acheminés selon leur URL.

Chaque microservice est défini dans l'utilisation de l'API 3.0 ouverte (Swagger). Si vous n'êtes pas sûr des points de terminaison de l'API liés à votre processus, contactez l'équipe d'intégration pour plus de support.

# Flux API

Le diagramme ci-dessous consiste à résumer les étapes à prendre lorsque vous essayez d'obtenir et publier des paramètres au DDB.

Diagramme des appels API nécessaires

Flow of API calls

Si vous ne savez pas où placer vos données dans la hiérarchie des actifs DDB ou si vous manquez la hiérarchie des arbres d'actifs, contactez l'équipe d'intégration pour plus de support. (opens new window)

Last Updated: 13/09/2023 15:19:15