# Dokumentacja API

API DDB składa się z wielu różnych mikrousług. Poniżej możesz zobaczyć różne usługi, z którymi możesz wchodzić w interakcje, wraz ze sposobem uwierzytelnienia i uzyskania dostępu.

# Mikrousług

Nasz API jest podzielony na *6 mikrousług *.

MicroService Cel
Usługa kontekstu środowiskowego Usługa kontekstu środowiska przechowuje aktualne dane projektów wykorzystywane w DDB.
Usługa parametrów Usługa dostarczająca informacji o zasobach i parametrach na temat projektów.
Parametr Metadata Service Usługa zapewniająca metadane dotyczące aktywów i parametrów projektów.
Serwis danych odniesienia Informacje o danych źródłowych wykorzystywane do zdefiniowania odniesień do źródeł wewnętrznych i zewnętrznych.
Usługa QA Prowadzi dane dotyczące usług QA.
Usługa komentarzy Usługa komentarzy ma na celu prowadzenie gwintowanych komentarzy dotyczących różnych systemów, zasobów i parametrów.

Każda mikrousług ma niezależną instancję dla każdego z trzech środowisk. Podsumowanie celu każdego środowiska patrz Tutaj .

Poniższa tabela zawiera linki do każdej mikrousług dla każdego środowiska.

MicroService *Rozwój Sandbox Produkcja
Usługa kontekstu środowiskowego środowisko_context_praca (opens new window) środowisko_context_praca (opens new window) środowisko_context_praca (opens new window)
Usługa parametrów parametr_service (opens new window) parametr_service (opens new window) parametr_service (opens new window)
Usługa metadanych parametrów parametr_metadata_praca (opens new window) parametr_metadata_praca (opens new window) parametr_metadata_praca (opens new window)
Serwis danych odniesienia reference_data_service (opens new window) reference_data_service (opens new window) reference_data_service (opens new window)
Usługa QA qa_service (opens new window) qa_service (opens new window) qa_service (opens new window)
Usługa komentarzy komentarze_service (opens new window) komentarze_service (opens new window) komentarze_service (opens new window)

*Tylko zespół programistów DDB powinien korzystać z środowiska programistycznego

Wszystkie różne usługi wykorzystują ten sam podstawowy adres URL (np. https://ddb.arup.com (opens new window)) i są kierowane do ich adresu URL.

Każda mikrousług jest zdefiniowana przy użyciu otwartego interfejsu API 3.0 (swagger). Jeśli nie masz pewności co do punktów końcowych API związanych z procesem, skontaktuj się z zespołem pokładowym, aby uzyskać więcej wsparcia.

# Przepływ API

Poniższy schemat podsumowuje kroki, które należy podjąć podczas próby uzyskania parametrów do DDB.

Potrzebny schemat połączeń API

Flow of API calls

Jeśli nie masz pewności, gdzie umieścić swoje dane w hierarchii zasobów DDB lub brakuje hierarchii drzewa zasobów, skontaktuj się z zespołem pokładowym, aby uzyskać więcej wsparcia. (opens new window)

Last Updated: 13.09.2023, 15:19:15