Guida all'integrazione di SAFE flex

Per un’integrazione fluida e semplice, consultate il flusso di lavoro dettagliato.

Il diagramma allegato illustra il flusso di lavoro e mette in evidenza i passaggi essenziali necessari per integrare correttamente l’API SAFE.

Configurazione

Per utilizzare l’API SAFE, è necessario creare un’organizzazione. All’interno di questa organizzazione, è necessario creare una chiave API. Inviate la chiave API e l’ID organizzazione.

Passo 1: Autenticazione

Per accedere all’API, è necessario un access_token JWT valido. Utilizzate l’endpoint retrieveToken per creare il token di accesso. Tramite il scope_id potete definire dove viene creata una risorsa.

Passo 2: Creare una configurazione

Utilizzate l’endpoint createConfiguration per definire il paese della posizione di archiviazione.

Passo 3: Creare un’annotazione

L’annotazione viene utilizzata per categorizzare i file. Utilizzate l’endpoint createAnnotation per creare un’annotazione. L’annotation_id identifica univocamente una risorsa file utilizzando un UUIDv4.

Passo 4: Archiviare un file

Utilizzate l’endpoint archiveFile per archiviare un file. La richiesta si compone di due parti:

• l’archive_file_request (contiene informazioni sul file) &
• il file stesso Prima di archiviare un file, è necessario aver già creato un’annotazione.

Passo 5: Cercare file

Utilizzate l’endpoint createSearch per cercare file specifici. Questa richiesta viene elaborata in modo asincrono. Il logical_operator viene utilizzato per collegare gli array di argomenti. Lo stato della query di ricerca può essere verificato tramite l’endpoint retrieveSearchQuery. Una volta elaborata la richiesta, i file possono essere recuperati tramite l’endpoint retrieveSearchQueryResults.

Passo 6: Creare un’esportazione

Per creare un’esportazione, utilizzate l’endpoint createExport. L’export_id deve essere un UUIDv4 creato sul vostro lato. Questa richiesta viene elaborata in modo asincrono. Lo stato di un’esportazione può essere verificato tramite l’endpoint retrieveExport. Una volta elaborata correttamente (stato: PROCESSED), la risposta include un link per il download. Per scaricare uno stream contenente i dati di esportazione di un’esportazione elaborata, utilizzate l’endpoint downloadExport.