Fichiers source

Le service de relais inclut une fonctionnalité permettant de publier les fichiers source utilisés lors de la partie d'extraction de données d'un sondage. Par exemple, un sondage pour ios_messages.messages examinera le fichier sms.db à partir d'une sauvegarde iOS pour récupérer les données du message - en utilisant le fichier source publiant le fichier sms.db lui-même sera renvoyé avec les données extraites et tous les fichiers joints pertinents.

Activation de la publication du fichier source

La publication du fichier source peut être activée par abonnement, via son attribut poll_payload ou via une configuration à l'échelle de l'organisation ou au niveau de la clé. Tous utilisent la même clé de configuration : publish_source_files

Création d'un abonnement avec la publication de fichiers source activée

curl https://ricloud-api.reincubate.com/subscriptions \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "source": "<child source ID>",
  "poll_payload": {
    "data_types": ["ios_messages.messages"],
    "publish_source_files": true
  }
}'

Configuration de la publication du fichier source au niveau de l'organisation

curl https://ricloud-api.reincubate.com/organisation \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Ce qui précède nécessite une clé d'administrateur d'organisation.

Configuration de la publication du fichier source au niveau de la clé

curl https://ricloud-api.reincubate.com/key \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Les configurations à l'échelle de l'organisation peuvent être remplacées par des configurations au niveau de la clé, ce qui peut être utile lorsque les fichiers source ne présentent d'intérêt que pour une utilisation en production. De même, les deux peuvent être remplacés par le paramètre poll payload, ce qui vous permet de spécifier si les fichiers source doivent être publiés au cas par cas.

Notez que l'activation des fonctionnalités via l'organisation ou la configuration de clé appliquera rétroactivement le comportement modifié aux abonnements existants.

Travailler avec les résultats du fichier source

Lorsque la publication du fichier source est activée, l'API suit tous les fichiers touchés dans le cadre du processus d'extraction, les publie dans votre compartiment de stockage et crée un objet de résultat associé au sondage en cours.

Une référence aux fichiers source liés à un ensemble particulier de données est incluse dans l'attribut metadata du résultat de données lui-même. Par exemple:

{
  "data": [{
    "id": "a1b2c3d4",
    "data_type": "message",
    "conversation_id": "w6x7y8z9",
    "handle": "Pal",
    "type": "SMS",
    "text": "Hi, how’s it going?",
    "attachments": [{
          "type": "image",
          "file_id": "a492be9a8dadabdc774286116232420224f14976",
          "file_path": "Library/SMS/Attachments/de/14/33A09D66-287E-4B64-A874-1A1234BD7E61/IMG_0006.PNG",
          "filename": "IMG_0006.PNG"
    }],
    "group_handles": [
      "Pal",
      "renate@reincubate.com"
    ],
    "from_me": false,
    "deleted": false,
    "date": "2020-01-01T00:00:00.000000Z"
  }],
  "metadata": {
    "count": 1,
    "filters": null,
    "source_files": [{
      "file_id": "3d0d7e5fb2ce288813306e4d4636395e047a3d28",
      "domain": "HomeDomain",
      "file_path": "Library/SMS/sms.db",
      "filename": "sms.db",
      "size": 123456,
      "date_last_modified": "2020-01-02T00:00:00.000000Z"
    }]
  }
}

Comme pour les résultats de fichiers joints, le file_id d'une entrée de fichier source correspond à l'attribut d' identifier du résultat auquel il est lié. Par conséquent, il s'agit également du nom du fichier écrit dans votre compartiment de stockage.