Guide d'intégration SAFE flex

Pour une intégration fluide et facile, veuillez vous référer au flux de travail détaillé.

Le diagramme ci-joint illustre le flux de travail et met en évidence les étapes essentielles nécessaires pour intégrer avec succès l’API SAFE.

Configuration

Pour utiliser l’API SAFE, une organisation doit être créée. Au sein de cette organisation, il est nécessaire de créer une clé API. Veuillez transmettre la clé API et l’ID d’organisation.

Étape 1 : Authentification

Pour accéder à l’API, vous avez besoin d’un access_token JWT valide. Utilisez l’endpoint retrieveToken pour créer le token d’accès. Via le scope_id, vous pouvez définir où une ressource est créée.

Étape 2 : Créer une configuration

Utilisez l’endpoint createConfiguration pour définir le pays de l’emplacement de stockage.

Étape 3 : Créer une annotation

L’annotation est utilisée pour catégoriser les fichiers. Utilisez l’endpoint createAnnotation pour créer une annotation. L’annotation_id identifie de manière unique une ressource de fichier en utilisant un UUIDv4.

Étape 4 : Archiver un fichier

Utilisez l’endpoint archiveFile pour archiver un fichier. La demande se compose de deux parties :

• l’archive_file_request (contient des informations sur le fichier) &
• le file lui-même Avant d’archiver un fichier, il est nécessaire d’avoir déjà créé une annotation.

Étape 5 : Rechercher des fichiers

Utilisez l’endpoint createSearch pour rechercher des fichiers particuliers. Cette demande est traitée de manière asynchrone. Le logical_operator est utilisé pour connecter les tableaux d’arguments. L’état de la requête de recherche peut être vérifié via l’endpoint retrieveSearchQuery. Une fois la demande traitée, les fichiers peuvent être récupérés via l’endpoint retrieveSearchQueryResults.

Étape 6 : Créer une exportation

Pour créer une exportation, utilisez l’endpoint createExport. L’export_id doit être un UUIDv4 créé de votre côté. Cette demande est traitée de manière asynchrone. L’état d’une exportation peut être vérifié via l’endpoint retrieveExport. Une fois traitée avec succès (état : PROCESSED), la réponse inclut un lien de téléchargement. Pour télécharger un flux contenant les données d’exportation d’une exportation traitée, utilisez l’endpoint downloadExport.