# API -documentatie
De DDB API bestaat uit een aantal verschillende microservices. Hieronder ziet u de verschillende services waarmee u kunt communiceren, samen met hoe u kunt authenticeren en toegang krijgt.
# Microservices
Onze API is gescheiden in *6 microservices *.
| Microservice | Doel |
|---|---|
| Milieucontext Service | De Environment Context Service slaat de huidige projectengegevens op die worden gebruikt in DDB. |
| Parameterservice | Een service die informatie biedt over activa en parameters over projecten. |
| Parameter Metadata -service | Een service die metagegevens biedt over activa en parameters op projecten. |
| Referentiegegevensservice | Brongegevensinformatie die wordt gebruikt om verwijzingen naar interne en externe bronnen te definiëren. |
| QA -service | Hosts QA -servicegegevens. |
| Opmerkingen Service | De opmerkingenservice is bedoeld om reacties met threaded te hosten die betrekking hebben op een verscheidenheid aan systemen, activa en parameters. |
Elke microservice heeft een onafhankelijk exemplaar voor elk van de drie omgevingen. Zie voor een samenvatting van het doel van elke omgeving hier .
De volgende tabel bevat links naar elke microservice, voor elke omgeving.
| Microservice | *Ontwikkeling | Zandbak | Productie |
|---|---|---|---|
| Milieucontextdienst | milieu_context_dienst (opens new window) | milieu_context_dienst (opens new window) | milieu_context_dienst (opens new window) |
| Parameterservice | parameter_service (opens new window) | parameter_service (opens new window) | parameter_service (opens new window) |
| Parameter Metadata -service | parameter_metadata_dienst (opens new window) | parameter_metadata_dienst (opens new window) | parameter_metadata_dienst (opens new window) |
| Referentiegegevensservice | referentie_data_service (opens new window) | referentie_data_service (opens new window) | referentie_data_service (opens new window) |
| QA -service | QA_SERVICE (opens new window) | QA_SERVICE (opens new window) | QA_SERVICE (opens new window) |
| Opmerkingen Service | Opmerkingen_service (opens new window) | Opmerkingen_service (opens new window) | Opmerkingen_service (opens new window) |
*Alleen het DDB -ontwikkelingsteam zou de ontwikkelingsomgeving moeten gebruiken
Alle verschillende services gebruiken dezelfde basis -URL (bijv.https://ddb.arup.com (opens new window)) en worden gerouteerd naar volgens hun URL.
Elke microservice wordt gedefinieerd in het gebruik van Open API 3.0 (SWAGGER). Als u niet zeker bent van API -eindpunten met betrekking tot uw proces, neem dan contact op met het onboarding -team voor meer ondersteuning.
# API -stroom
Diagram hieronder is een samenvatting van de stappen die u moet nemen wanneer u probeert parameters te krijgen en te posten op de DDB.
Diagram van API -oproepen nodig
Versies →