# API -Dokumentation
Die DDB -API besteht aus einer Reihe verschiedener Mikrodienste. Im Folgenden können Sie die verschiedenen Dienste sehen, mit denen Sie interagieren können, sowie die Authentifizierung und den Zugriff.
# Microservices
Unsere API ist getrennt in *6 Microservices *.
| Microservice | Zweck |
|---|---|
| Umweltkontextdienst | Der Umgebungskontextdienst speichert die aktuellen Projektdaten, die in DDB verwendet werden. |
| Parameterdienst | Ein Dienst, der Informationen zu Vermögenswerten und Parametern für Projekte bietet. |
| Parameter Metadatendienst | Ein Dienst, der Metadaten für Vermögenswerte und Parameter für Projekte bietet. |
| Referenzdatendienst | Quelldateninformationen, die zur Definition von Verweise auf interne und externe Quellen verwendet werden. |
| QA -Service | Hostet QA -Dienstdaten. |
| Kommentare Service | Der Kommentardienst soll Thread -Kommentare hosten, die sich auf eine Vielzahl von Systemen, Vermögenswerten und Parametern beziehen. |
Jeder Microservice verfügt über eine unabhängige Instanz für jede der drei Umgebungen. Für eine Zusammenfassung des Zwecks jeder Umgebung siehe Hier .
Die folgende Tabelle enthält Links zu jedem Microservice für jede Umgebung.
| Microservice | *Entwicklung | Sandkasten | Produktion |
|---|---|---|---|
| Umweltkontextdienst | Umgebung_Context_Service (opens new window) | Umgebung_Context_Service (opens new window) | Umgebung_Context_Service (opens new window) |
| Parameterdienst | Parameter_Service (opens new window) | Parameter_Service (opens new window) | Parameter_Service (opens new window) |
| Parameter -Metadatendienst | parameter_metadata_Service (opens new window) | parameter_metadata_Service (opens new window) | parameter_metadata_Service (opens new window) |
| Referenzdatenservice | reference_data_service (opens new window) | reference_data_service (opens new window) | reference_data_service (opens new window) |
| QA -Service | QA_Service (opens new window) | QA_Service (opens new window) | QA_Service (opens new window) |
| Kommentarservice | commentes_service (opens new window) | commentes_service (opens new window) | commentes_service (opens new window) |
*Nur das DDB -Entwicklungsteam sollte die Entwicklungsumgebung nutzen
Alle verschiedenen Dienste verwenden dieselbe Basis -URL (z.https://ddb.arup.com (opens new window)) und werden nach ihrer URL weitergeleitet.
Jeder Microservice wird in der Verwendung von Open API 3.0 (Prahlerei) definiert. Wenn Sie sich über API -Endpunkte im Zusammenhang mit Ihrem Prozess nicht sicher sind, wenden Sie sich an das Onboarding -Team, um mehr Unterstützung zu erhalten.
# API -Fluss
Das Diagramm unten fasst die Schritte zusammen, die zu erledigen sind, wenn Sie versuchen, Parameter in die DDB zu erhalten.
Diagramm der API -Anrufe benötigt
