# Documentación de API

La API DDB está compuesta por una serie de microservicios diferentes. A continuación puede ver los diferentes servicios con los que puede interactuar, junto con cómo autenticarse y obtener acceso.

# Microservicios

Nuestra API está segregada en microservicios.

Microservicio Propósito
Comments Service Aloja comentarios encadenados que se relacionan con una variedad de sistemas, activos y parámetros.
Environment Context Service Almacena los proyectos actuales en DDB y se vincula a sistemas Arup más amplios a través de ADS.
Parameter Metadata Service Proporciona metadatos sobre activos y parámetros de proyectos.
Parameter Service Almacena datos de activos y parámetros sobre proyectos.
QA Service Almacena los datos de control de calidad relacionados con parámetros y entradas.
Reference Data Service Define referencias a fuentes internas y externas. Contiene las fuentes de los valores de los parámetros.
Taxonomy Service Contiene la taxonomía DDB.
Template Service Contiene estructuras de plantillas de parámetros y activos que se pueden utilizar para la creación de contenido y procesos automatizados.
User Service Gestiona los roles de los usuarios en los proyectos para definir los permisos de acceso por proyectos.

Cada microservicio tiene una instancia independiente para cada uno de los tres entornos. Para un resumen del propósito de cada entorno, ver aquí .

La siguiente tabla incluye enlaces a cada microservicio, para cada entorno.

Microservice *Development Sandbox Production
comments_service comments_service comments_service
environment_context_
service
environment_context_
service
environment_context_
service
parameter_metadata_
service
parameter_metadata_
service
parameter_metadata_
service
parameter_service parameter_service parameter_service
qa_service qa_service qa_service
reference_data_
service
reference_data_
service
reference_data_
service
taxonomy_service taxonomy_service taxonomy_service
template_service template_service template_service
user_service user_service user_service

*Solo el equipo de desarrollo de DDB debería estar utilizando el entorno de desarrollo

Todos los diferentes servicios utilizan la misma URL base (p. Ej.https://ddb.arup.com (opens new window)) y se enrutan según su URL.

Cada microservicio se define en el uso de API 3.0 (arrogancia) Open. Si no está seguro de los puntos finales de API relacionados con su proceso, comuníquese con el equipo de incorporación para obtener más apoyo.

# Muy pronto

Microservicio Propósito
Audit Service Almacena un registro de todos los eventos y devuelve un historial de cambios dentro de un ámbito determinado.

# Flujo de API

El diagrama a continuación está resumiendo los pasos a tomar al intentar obtener y publicar parámetros en el DDB.

Diagrama de llamadas API necesarias

Flow of API calls

Si no está seguro de dónde colocar sus datos en la jerarquía de activos DDB o le faltan la jerarquía de árboles de activos, comuníquese con el equipo de incorporación para obtener más apoyo. (opens new window)

Last Updated: 24/9/2024, 16:41:45