Migra los extremos de SOAR a la API de Chronicle

Compatible con:

En este documento, se describen los pasos y las consideraciones para migrar de la superficie de la API de SOAR obsoleta a la API unificada de Chronicle. El objetivo de esta guía es ayudarte a realizar la transición de forma fluida y eficiente, minimizar las interrupciones y aprovechar las nuevas funcionalidades.

La plataforma de la API de Chronicle presenta varias mejoras diseñadas para optimizar tu proceso de desarrollo. También aborda las limitaciones y complejidades presentes en la API anterior.

Requisitos previos

Antes de realizar la migración de la API de SOAR, debes hacer lo siguiente:

Mejoras y cambios clave

En la siguiente tabla, se destacan las principales diferencias entre las superficies de la API antigua y la nueva:

Área de características API anterior Nueva API Detalles
Autenticación Token de API OAuth 2.0 El nuevo método de autenticación proporciona mayor seguridad y estandariza el proceso.
Modelos de datos Estructuras planas Diseño orientado a recursos Este nuevo diseño mejora la coherencia de los datos y simplifica la manipulación de objetos.
Nombres de extremos Incoherente Estandarizada y RESTful Los nombres coherentes hacen que la API sea más intuitiva y fácil de integrar.

Programa de baja

Está previsto que la antigua superficie de la API de SOAR deje de estar disponible por completo el 30 de junio de 2026. Te recomendamos que completes la migración antes de esta fecha para evitar interrupciones en el servicio.

Pasos para la migración

En esta sección, se describen los pasos para migrar correctamente tus aplicaciones a la API de Chronicle:

Revisa la documentación

Familiarízate con la documentación completa de la nueva API, incluida la guía de referencia de la API de Chronicle.

Asigna extremos a la nueva superficie de la API

Identifica los nuevos extremos correspondientes para cada una de las llamadas a la API anterior que realiza tu aplicación. Del mismo modo, asigna los modelos de datos antiguos a los nuevos, teniendo en cuenta los cambios estructurales o los campos nuevos. Para obtener más detalles, consulta la tabla de asignación de extremos de la API.

Opcional: Crea una integración de etapa de pruebas

Si editas una integración personalizada o un componente de una integración comercial, te recomendamos que primero envíes los cambios a una integración de etapa de pruebas. Este proceso te permite realizar pruebas sin afectar los flujos de automatización de producción. Si migras una aplicación compilada de forma personalizada que usa la API de SOAR, puedes pasar al siguiente paso. Para obtener detalles sobre la etapa de pruebas de integración, consulta Prueba integraciones en el modo de etapa de pruebas.

Actualiza el extremo y las URLs del servicio

Un extremo de servicio es la URL base que especifica la dirección de red de un servicio de API. Un solo servicio puede tener varios extremos de servicio. Chronicle es un servicio regional y solo admite extremos regionales.

Todos los extremos nuevos usan un prefijo coherente, lo que hace que la dirección del extremo final sea predecible. En el siguiente ejemplo, se muestra la nueva estructura de la URL del extremo:

[api_version]/projects/[project_id]/locations/[location]/instances[instance_id]/...

Esta estructura hace que la dirección final del extremo sea la siguiente:

https://[service_endpoint]/[api_version]/projects/[project_id]/locations/[location]/instances/[instance_id]/...

Aquí:

  • service_endpoint: Una dirección de servicio regional
  • api_version: Es la versión de la API que se consultará. Puede ser v1alpha, v1beta o v1.
  • project_id: Tu ID del proyecto (el mismo proyecto que definiste para tus permisos de IAM)
  • location: Es la ubicación de tu proyecto (región), que es la misma que la de los extremos regionales.
  • instance_id: Es tu ID de cliente de Google Security Operations SIEM.

Direcciones regionales:

  • africa-south1: https://chronicle.africa-south1.rep.googleapis.com

  • asia-northeast1: https://chronicle.asia-northeast1.rep.googleapis.com

  • asia-south1: https://chronicle.asia-south1.rep.googleapis.com

  • asia-southeast1: https://chronicle.asia-southeast1.rep.googleapis.com

  • asia-southeast2: https://chronicle.asia-southeast2.rep.googleapis.com

  • australia-southeast1: https://chronicle.australia-southeast1.rep.googleapis.com

  • europe-west12: https://chronicle.europe-west12.rep.googleapis.com

  • europe-west2: https://chronicle.europe-west2.rep.googleapis.com

  • europe-west3: https://chronicle.europe-west3.rep.googleapis.com

  • europe-west6: https://chronicle.europe-west6.rep.googleapis.com

  • europe-west9: https://chronicle.europe-west9.rep.googleapis.com

  • me-central1: https://chronicle.me-central1.rep.googleapis.com

  • me-central2: https://chronicle.me-central2.rep.googleapis.com

  • me-west1: https://chronicle.me-west1.rep.googleapis.com

  • northamerica-northeast2: https://chronicle.northamerica-northeast2.rep.googleapis.com

  • southamerica-east1: https://chronicle.southamerica-east1.rep.googleapis.com

  • nosotros: https://chronicle.us.rep.googleapis.com

  • eu: https://chronicle.eu.rep.googleapis.com

Por ejemplo, para obtener una lista de todos los casos de un proyecto en EE.UU., haz lo siguiente:

GET 
  https://chronicle.us.rep.googleapis.com/v1alpha/projects/my-project-name-or-id/locations/us/instances/408bfb7b-5746-4a50-885a-50a323023529/cases

Actualiza el método de autenticación

La nueva API usa Google Cloud IAM para la autenticación. Deberás actualizar tu aplicación o integración de respuestas para implementar este nuevo flujo de autenticación. Asegúrate de que el usuario que ejecuta la secuencia de comandos tenga los permisos correctos para los extremos a los que intenta acceder.

Actualiza la lógica de la API

Analiza los nuevos modelos de datos y las estructuras de extremos que se proporcionan en la referencia de la API. No todos los métodos cambiaron de forma significativa, y se puede reutilizar parte del código existente. El objetivo principal es revisar la nueva documentación de referencia y, para cada caso de uso específico, identificar e implementar los cambios necesarios en los nombres de los campos y las estructuras de datos dentro de la lógica de tu aplicación.

Prueba tu integración

Prueba tu aplicación actualizada en una integración de etapa de pruebas antes de implementarla en producción:

  1. Crea un plan de pruebas: Define casos de prueba que abarquen todas las funciones migradas.
  2. Ejecuta pruebas: Realiza pruebas automatizadas y manuales para confirmar la precisión y la validez.
  3. Supervisa el rendimiento: Evalúa el rendimiento de tu aplicación con la nueva API.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.