# Documentazione API

L'API DDB è costituita da un numero di microservizi diversi. Di seguito puoi vedere i diversi servizi con cui puoi interagire, insieme a come autenticare e ottenere l'accesso.

# Microservizi

La nostra API è separata in *6 microservizi *.

Microservice Scopo
Servizio di contesto ambientale Il servizio di contesto dell'ambiente memorizza i dati attuali utilizzati in DDB.
Servizio di parametri Un servizio che fornisce informazioni su risorse e parametri sui progetti.
Servizio metadati di parametri Un servizio che fornisce metadati su risorse e parametri sui progetti.
Servizio dati di riferimento Informazioni sui dati di origine utilizzati per definire i riferimenti a fonti interne ed esterne.
Servizio QA Host Data di servizio QA.
Servizio commenti Il servizio di commenti ha lo scopo di ospitare commenti thread che si riferiscono a una varietà di sistemi, risorse e parametri.

Ogni microservizio ha un'istanza indipendente per ciascuno dei tre ambienti. Per un riepilogo dello scopo di ogni ambiente, vedi Qui .

La seguente tabella include collegamenti a ciascun microservizio, per ciascun ambiente.

Microservizio *Sviluppo Sandbox Produzione
Servizio di contesto ambientale Environment_Context_servizio (opens new window) Environment_Context_servizio (opens new window) Environment_Context_servizio (opens new window)
Servizio di parametri parametro_service (opens new window) parametro_service (opens new window) parametro_service (opens new window)
Servizio di metadati dei parametri parametro_metadata_servizio (opens new window) parametro_metadata_servizio (opens new window) parametro_metadata_servizio (opens new window)
Servizio dati di riferimento Reference_data_service (opens new window) Reference_data_service (opens new window) Reference_data_service (opens new window)
Servizio QA qa_service (opens new window) qa_service (opens new window) qa_service (opens new window)
Servizio di commenti commenti_service (opens new window) commenti_service (opens new window) commenti_service (opens new window)

*Solo il team di sviluppo DDB dovrebbe utilizzare l'ambiente di sviluppo

Tutti i diversi servizi utilizzano lo stesso URL di base (ad es.https://ddb.arup.com (opens new window)) e vengono instradati secondo il loro URL.

Ogni microservizio è definito nell'uso dell'API Open 3.0 (spavalderia). Se non sei sicuro degli endpoint API relativi al processo, contatta il team di onboarding per un maggiore supporto.

# Flusso API

Il diagramma seguente sta riassumendo i passaggi da adottare quando si tenta di ottenere e pubblicare parametri al DDB.

Diagramma delle chiamate API necessaria

Flow of API calls

Se non sei sicuro di dove posizionare i tuoi dati nella gerarchia delle risorse DDB o ti manchi la gerarchia degli alberi delle risorse, contatta il team di onboarding per un maggiore supporto. (opens new window)

Last Updated: 13/9/2023, 15:19:15