Guía de integración de SAFE flex

Para una integración fluida y sencilla, consulta el flujo de trabajo detallado.

El diagrama adjunto ilustra el flujo de trabajo y destaca los pasos esenciales necesarios para integrar correctamente la API SAFE.

Configuración

Para utilizar la API SAFE, debe crearse una organización. Dentro de esta organización, es necesario crear una clave de API. Por favor, envía la clave de API y el ID de la organización.

Paso 1: Autenticación

Para acceder a la API, necesita un access_token JWT válido. Utiliza el endpoint retrieveToken para crear el token de acceso. A través del scope_id puede definir dónde se crea un recurso.

Paso 2: Crear una configuración

Utiliza el endpoint createConfiguration para definir el país de la ubicación de almacenamiento.

Paso 3: Crear una anotación

La anotación se utiliza para categorizar archivos. Utiliza el endpoint createAnnotation para crear una anotación. El annotation_id identifica de forma única un recurso de archivo usando un UUIDv4.

Paso 4: Archivar un archivo

Utiliza el endpoint archiveFile para archivar un archivo. La solicitud consta de dos partes:

• el archive_file_request (contiene información sobre el archivo) &
• el file en sí mismo Antes de archivar un archivo, es necesario haber creado ya una anotación.

Paso 5: Buscar archivos

Utiliza el endpoint createSearch para buscar archivos específicos. Esta solicitud se procesa de forma asíncrona. El logical_operator se utiliza para conectar los arrays de argumentos. El estado de la consulta de búsqueda puede verificarse a través del endpoint retrieveSearchQuery. Una vez que la solicitud haya sido procesada, los archivos pueden recuperarse a través del endpoint retrieveSearchQueryResults.

Paso 6: Crear una exportación

Para crear una exportación, utiliza el endpoint createExport. El export_id debe ser un UUIDv4 creado en su lado. Esta solicitud se procesa de forma asíncrona. El estado de una exportación puede verificarse a través del endpoint retrieveExport. Una vez que se haya procesado correctamente (estado: PROCESSED), la respuesta incluye un enlaza de descarga. Para descargar un flujo que contiene los datos de exportación de una exportación procesada, utiliza el endpoint downloadExport.