CSSCurrent de:Automatisierter Download von Transfers

---

Über den automatisierten Download von Transfers

Zum Zweck der Automatisierung von Downloads ist es möglich, einen Transfer direkt, ohne das Benutzerinterface bedienen zu müssen, herunterzuladen. Hierfür muss der zusätzliche GET Parameter 'get' zu der URL des Transfers hinzugefügt werden:

Neu: https://<Cryptshare Server URL>/download?id=<transfer-id>&password=<passwort>&<get[=all|=checksums|=allWithChecksums|=<file-id>]>

Alt: https://<Cryptshare Server URL>/download1.php?id=<transfer-id>&password=<passwort>&<get[=all|=checksums|allWithChecksums|=<file-id>]>

Die alte URL ist weiterhin funktionsfähig, wird jedoch in einer zukünftigen Version entfernt.

Metainformationen über einen Transfer abrufen

Wird nur der 'get' Parameter hinzugefügt, so erhält man ein TXT-Dokument per http-Download angeboten, welches Informationen über den Transfer enthält. Die Information wird als JSON-kompatibler Datensatz bereitgestellt. Aufbau des JSON-Datensatzes (Beispieldaten): {

   "file_1":[  
      {  
         "6ac31d4b8b":[  
            "transferFile_1.txt"
         ],
         "size":[  
            0
         ],
         "sha1":[  
            ""
         ],
		 "checksum":[  
            "0a28b295a883e4122c36482e4b0ad2275bbd2ebd60d066dc6f9e7fe6922ad7f4"
         ],
		 "checksumAlgorithm":[  
            "SHA-256"
         ]
      }
   ],
   "file_2":[  
      {  
         "4f0109ad8b":[  
            "transferFile_2.txt"
         ],
         "size":[  
            0
         ],
  	     "sha1":[  
            ""
         ],
         "checksum":[  
            "32d9c815c2c3cf989007b613d37844d919a1e7070b67a501150d760ac860505e"
         ],
		 "checksumAlgorithm":[  
            "SHA-256"
         ]
       
      }
   ],
   "totalSize":[  
      0
   ]
}

`https://cryptshare.ihredomain.de/download?id=234ds43re&password=23erwr2er&get` Die Datei führt alle in dem Transfer enthaltenen Dateien zusammen mit der entsprechenden File-ID auf. Dadurch erhält man die Möglichkeit, eine bestimmte Datei zu finden und mit einem zweiten Aufruf herunterzuladen.

Herunterladen von bestimmten Dateien

Wird der 'get' Parameter zusammen mit einer bestimmten File-ID verwendet, so erhält man einen HTTP Download für die Datei, welche dieser ID entspricht. `https://cryptshare.ihredomain.de/download?id=234ds43re&password=23erwr2er&get=6ac31d4b8b` Gemäß den Metainformationen aus dem o.g. Beispiel wird dieser Aufruf die Datei 'transferFile_1.txt' herunterladen.

Alle Dateien eines Transfers herunterladen

Wird der 'get' Parameter zusammen mit dem Schlüsselwort 'all' verwendet, so erhält man einen HTTP-Download für eine Zip-Datei, welche alle Dateien des Transfers enthält. `https://cryptshare.ihredomain.de/download?id=234ds43re&password=23erwr2er&get=all` Dieser Aufruf wird die Datei 'cs-transfer.zip' herunterladen, in welcher, gemäß obenstehenden Metainformationen, die Dateien 'transferFile_1.txt' und 'transferFile_2.txt' enthalten sind.

Hashwerte der Dateien eines Transfers herunterladen

Wird der 'get' Parameter zusammen mit dem Schlüsselwort 'checksums' verwendet, so erhält man einen HTTP-Download für eine CSV-Datei, welche Informationen zum Transfer enthält. Diese Informationen enthalten den Betreff der Benachrichtigungsmail und eine Liste der Transferdateien mit ihren jeweiligen Hashwerten. `https://cryptshare.ihredomain.de/download?id=234ds43re&password=23erwr2er&get=checksums` Dieser Aufruf wird die Datei 'checksums.csv' herunterladen, in welcher, gemäß obenstehenden Metainformationen, folgende Einträge enthält:

Dateiname	Hashwert
transferFile_1.txt	0a28b295a883e4122c36482e4b0ad2275bbd2ebd60d066dc6f9e7fe6922ad7f4 (SHA-256)
transferFile_2.txt	32d9c815c2c3cf989007b613d37844d919a1e7070b67a501150d760ac860505e (SHA-256)

Alle Dateien und die Hashwerte eines Transfers herunterladen

Wird der 'get' Parameter zusammen mit dem Schlüsselwort 'allWithChecksums' verwendet, so erhält man einen HTTP-Download für eine Zip-Datei, welche alle Dateien des Transfers und eine CSV-Datei enthält, die die Hashwerte der einzelnen Dateien enthält. `https://cryptshare.ihredomain.de/download?id=234ds43re&password=23erwr2er&get=allWithChecksums` Dieser Aufruf wird die Datei 'cs-transfer.zip' herunterladen, in welcher, gemäß obenstehenden Metainformationen, die Dateien 'transferFile_1.txt', 'transferFile_2.txt' und 'checksums.csv' enthalten sind.

HTTP Fehlercodes und -meldungen

Das Cryptshare Benutzerinterface wird sich anders verhalten, wenn der 'get' Parameter mit falschen Angaben verwendet wird. Im Gegensatz zu den Fehlermeldungen, welche normalerweise bei einer Falscheingabe im Webformular angezeigt werden, wird das Interface mit einem HTTP Fehlercode, abhängig vom Fehlerfall und der entsprechenden Fehlermeldung, antworten.

Situation	Code	Code Beschreibung
Es wurde keine Transfer-ID angegeben Es wurde kein Passwort angegeben	400	Bad Request
Die Transfer-ID wurde nicht gefunden Es wurden keine Transfer Dateien gefunden Der Transfer wurde gelöscht Die Datei-ID wurde nicht gefunden	404	Not found
Es wurde falsche Authentifizierungsdaten angegeben	401	Unauthorized
Der Transfer wurde aufgrund falscher Authentifizierung mit dieser Anfrage gelöscht	410	Gone
Der Transfer wurde bereits gesperrt Der Transfer wurde aufgrund falscher Authentifizierung gesperrt	403	Forbidden
Der Download des Transfers erfordert eine vorherige erfolgreiche ID-Provider-Authentifizierung. Derzeit können solche Transfers nicht über diese Schnittstelle abgerufen werden.	412	Precondition failed
Erfolgreicher Abruf	200	OK

Dies vereinfacht das Identifizieren von Downloadproblemen, wenn dieses Feature in Automatisierungsskripten oder APIs verwendet wird.

---