Integrationsleitfaden SAFE flex

Für eine reibungslose und einfache Integration folgen Sie bitte dem detaillierten Workflow.

Das begleitende Diagramm veranschaulicht den Workflow und hebt die wesentlichen Schritte hervor, die für eine erfolgreiche Integration der SAFE API erforderlich sind.

Einrichtung

Um die SAFE API zu nutzen, muss eine Organisation erstellt werden. Innerhalb dieser Organisation ist es notwendig, einen API-Schlüssel zu erstellen. Bitte übermitteln Sie den API-Schlüssel und die Organisations-ID.

Schritt 1: Authentifizierung

Um auf die API zugreifen zu können, benötigen Sie ein gültiges JWT access_token. Verwenden Sie den retrieveToken Endpunkt, um das Zugriffstoken zu erstellen. Über die scope_id können Sie festlegen, wo eine Ressource erstellt wird.

Schritt 2: Konfiguration erstellen

Verwenden Sie den createConfiguration Endpunkt, um das Land des Speicherorts festzulegen.

Schritt 3: Annotation erstellen

Die Annotation wird zur Kategorisierung von Dateien verwendet. Verwenden Sie den createAnnotation Endpunkt, um eine Annotation zu erstellen. Die annotation_id identifiziert eine Dateiressource eindeutig durch eine UUIDv4.

Schritt 4: Datei archivieren

Verwenden Sie den archiveFile Endpunkt, um eine Datei zu archivieren. Die Anfrage besteht aus zwei Teilen:

• der archive_file_request (enthält Informationen über die Datei) &
• die file selbst Vor der Archivierung einer Datei muss bereits eine Annotation erstellt worden sein.

Schritt 5: Dateien suchen

Verwenden Sie den createSearch Endpunkt, um nach bestimmten Dateien zu suchen. Diese Anfrage wird asynchron verarbeitet. Der logical_operator wird verwendet, um die Argument-Arrays zu verbinden. Der Status der Suchanfrage kann über den retrieveSearchQuery Endpunkt überprüft werden. Sobald die Anfrage verarbeitet wurde, können die Dateien über den retrieveSearchQueryResults Endpunkt abgerufen werden.

Schritt 6: Export erstellen

Um einen Export zu erstellen, verwenden Sie den createExport Endpunkt. Die export_id muss eine auf Ihrer Seite erstellte UUIDv4 sein. Diese Anfrage wird asynchron verarbeitet. Der Status eines Exports kann über den retrieveExport Endpunkt überprüft werden. Sobald er erfolgreich verarbeitet wurde (Status: PROCESSED), enthält die Antwort einen Download-Link. Um einen Stream mit Exportdaten eines verarbeiteten Exports herunterzuladen, verwenden Sie den downloadExport Endpunkt.