File sorgenti

Il servizio di inoltro include la funzionalità per pubblicare i file di origine utilizzati durante la parte di estrazione dei dati di un sondaggio. Ad esempio, un sondaggio per ios_messages.messages esaminerà il file sms.db da un backup iOS per recuperare i dati del messaggio: utilizzando la pubblicazione del file di origine, il file sms.db stesso verrà restituito insieme ai dati estratti e agli eventuali file allegati pertinenti.

Abilitazione della pubblicazione del file di origine

La pubblicazione del file di origine può essere abilitata in base all'abbonamento, tramite l'attributo poll_payload o tramite una configurazione a livello di organizzazione oa livello di chiave. Tutti usano la stessa chiave di configurazione: publish_source_files

Creazione di una sottoscrizione con la pubblicazione del file di origine abilitata

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
  }
}'

Configurazione della pubblicazione dei file di origine a livello di organizzazione

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
  }
}'

Quanto sopra richiede una chiave di amministratore dell'organizzazione.

Configurazione della pubblicazione dei file di origine a livello di chiave

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
  }
}'

Le configurazioni a livello di organizzazione possono essere sostituite da configurazioni a livello di chiave, che possono essere utili quando i file di origine sono di interesse solo per l'utilizzo in produzione. Allo stesso modo, entrambi possono essere sovrascritti dal parametro del payload poll, che consente di specificare se i file di origine devono essere pubblicati caso per caso.

Tieni presente che l'abilitazione delle funzionalità tramite l'organizzazione o la configurazione della chiave applicherà retroattivamente il comportamento modificato agli abbonamenti esistenti.

Lavorare con i risultati del file di origine

Quando la pubblicazione dei file di origine è abilitata, l'API tiene traccia di tutti i file toccati come parte del processo di estrazione, li pubblica nel bucket di archiviazione e crea un oggetto risultato associato al sondaggio corrente.

Un riferimento ai file di origine relativi a un particolare set di dati è incluso nell'attributo metadata del risultato dati stesso. Per esempio:

{
  "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"
    }]
  }
}

Come per i risultati del file allegato, il file_id di una voce del file di origine corrisponde all'attributo identifier del risultato a cui è correlato. Pertanto, questo è anche il nome del file scritto nel bucket di archiviazione.