Skip to content

Guide de Démarrage Rapide

Démarrez avec l'API d'Anonymisation en 5 étapes simples. Ce guide vous guidera à travers le processus complet, de l'authentification à l'exécution de votre première tâche d'anonymisation.

Prérequis

  • URL du point d'accès à l'API
  • Email et mot de passe valides pour l'inscription
  • Documents ou sources de données à anonymiser

Étape 1 : Authentification

Enregistrer un Nouvel Utilisateur

curl -X POST "https://your-api-domain.com/api/auth/register" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john.doe@example.com",
    "password": "secure_password_123"
  }'

Se Connecter pour Obtenir un Jeton d'Accès

curl -X POST "https://your-api-domain.com/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com",
    "password": "secure_password_123"
  }'

Réponse: 

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}

Enregistrez Votre Jeton

Stockez le jeton d'accès en toute sécurité. Vous en aurez besoin pour tous les appels API suivants.

Étape 2 : Créer des Règles d'Anonymisation

Créez des règles pour définir quoi et comment anonymiser vos données. Vous pouvez utiliser des modèles regex ou des modèles d'IA.

Créer une Règle Regex pour les Adresses Email

curl -X POST "https://your-api-domain.com/api/rules/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anonymiseur d'Email",
    "description": "Anonymise les adresses email",
    "type": "REGEX",
    "config": {
      "regexRuleConfig": {
        "pattern": "\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Z|a-z]{2,}\\b"
      }
    }
  }'

Créer une Règle de Modèle d'IA pour les Noms

curl -X POST "https://your-api-domain.com/api/rules/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Détecteur de Noms Béninois",
    "description": "Détecte les noms béninois en utilisant le modèle GLiNER",
    "type": "AIMODEL",
    "config": {
      "aiModelRuleConfig": {
        "modelId": "gliner-beninese-names",
        "modelVersion": "v1.0",
        "modelParameters": {
          "confidence_threshold": 0.8
        }
      }
    }
  }'

Réponse: 

{
  "id": "rule_123456789",
  "name": "Détecteur de Noms Béninois",
  "type": "AIMODEL",
  "config": {...}
}

Étape 3 : Créer un Flux de Travail avec des Règles d'Anonymisation

Combinez vos règles en un flux de travail qui définit le processus complet d'anonymisation.

curl -X POST "https://your-api-domain.com/api/workflows/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anonymisation PII de Document",
    "description": "Flux de travail complet pour anonymiser les PII dans les documents",
    "supportedAssetType": "DOCUMENT",
    "config": {
      "rules": [
        {
          "ruleId": "rule_123456789",
          "replacement": {
            "text": "[NOM_MASQUÉ]"
          }
        },
        {
          "ruleId": "rule_email_123",
          "replacement": {
            "text": "[EMAIL_MASQUÉ]"
          }
        }
      ]
    }
  }'

Réponse: 

{
  "id": "workflow_987654321",
  "name": "Anonymisation PII de Document",
  "supportedAssetType": "DOCUMENT",
  "config": {...}
}

Étape 4 : Télécharger des Documents et Sélectionner un Flux de Travail

Téléchargez vos documents pour créer une tâche, puis associez-la à votre flux de travail.

Télécharger des Documents

curl -X POST "https://your-api-domain.com/api/jobs/upload" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "files=@document1.pdf" \
  -F "files=@document2.docx" \
  -F "name=Ma Tâche d'Anonymisation" \
  -F "description=Anonymisation de documents sensibles"

Réponse: 

{
  "id": "job_456789123",
  "name": "Ma Tâche d'Anonymisation",
  "status": "PENDING",
  "Assets": [...]
}

Associer un Flux de Travail à une Tâche

curl -X PUT "https://your-api-domain.com/api/jobs/job_456789123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workflowId": "workflow_987654321"
  }'

Étape 5 : Exécuter l'Anonymisation

Exécutez la tâche d'anonymisation et surveillez sa progression.

Exécuter la Tâche

curl -X POST "https://your-api-domain.com/api/jobs/job_456789123/execute" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Réponse: 

{
  "id": "job_456789123",
  "status": "IN_PROGRESS",
  "result": null
}

Surveiller l'État de la Tâche

curl -X GET "https://your-api-domain.com/api/jobs/job_456789123/status" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Réponses possibles: - PENDING - Tâche mise en file d'attente - IN_PROGRESS - Tâche en cours d'exécution - SUCCEEDED - Tâche terminée avec succès - FAILED - Tâche a rencontré une erreur - CANCELLED - Tâche a été annulée

Obtenir les Résultats de la Tâche

Une fois que l'état est SUCCEEDED, récupérez vos documents anonymisés:

curl -X GET "https://your-api-domain.com/api/jobs/job_456789123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Alternative: Charger à partir de Sources de Données

Au lieu de télécharger des fichiers, vous pouvez vous connecter à des sources de données existantes:

Créer une Connexion Source

curl -X POST "https://your-api-domain.com/api/sources/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Documents SharePoint",
    "kind": "SHAREPOINT",
    "config": {
      "site_url": "https://yourcompany.sharepoint.com/sites/docs",
      "client_id": "your_client_id",
      "client_secret": "your_client_secret"
    }
  }'

Charger des Actifs depuis la Source

curl -X POST "https://your-api-domain.com/api/jobs/load" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceId": "source_123",
    "sourceType": "SHAREPOINT",
    "files_load_config": {
      "filenames": ["document1.pdf", "document2.docx"]
    }
  }'

Prochaines étapes

Dépannage

Problèmes Courants

Authentification Échouée

Assurez-vous que votre jeton d'accès est valide et inclus dans l'en-tête Authorization sous la forme Bearer YOUR_TOKEN.

Tâche Échouée

Vérifiez les détails de la tâche pour voir les messages d'erreur spécifiques. Les problèmes courants incluent: - Configuration de flux de travail invalide - Formats de fichiers non pris en charge - Erreurs de chargement de modèle (assurez-vous que le GPU est disponible)

Optimisation des Performances

Pour les documents volumineux ou le traitement à haut volume, envisagez: - Utiliser des téléchargements par batches - Optimiser les modèles regex - Assurer une mémoire GPU adéquate pour les modèles d'IA