VBScript Requires Chilkat v11.7.0+
VBScript
Box: Resolve a File Version by Name and Verify the Download
See more Box Examples
Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. One target request requires file_id and file_version_id. The engine uses AddOutput2 for name lookups and AddOutput for version/SHA-1 metadata, then downloads that version to local_path and verifies its digest.
See the Box API guide for setup and the complete workflow.
Chilkat VBScript Downloads
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
success = 0
' Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
' See Global Unlock Sample.
' Guide: Box API Guide.
success = 0
' BEGIN ONE-TIME SETUP
' This block is repeated so each published example can run on its own.
' In an application, run the setup example once and pass the SAME curl object
' to operation code below. Do not recreate it for every operation.
' See Reusable Box HttpCurl Setup.
set curl = CreateObject("Chilkat.HttpCurl")
curl.SetVar "access_token","BOX_ACCESS_TOKEN"
curl.SetVar "parent_name","/"
' Box's fixed root ID is an implementation detail; callers supply names.
curl.SetVar "parent_id","0"
set setupCommand = CreateObject("Chilkat.StringBuilder")
' Register findParent; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findParent",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register findFolder; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findFolder",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register findFile; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findFile",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register findDestination; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findDestination",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register getFileDetails; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("getFileDetails",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register getEnterprise; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/users/me?fields=enterprise"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("getEnterprise",setupCommand.GetAsString())
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
' when extracting each output, using the current value at that time.
success = curl.AddOutput2("findParent","entries","name","{{parent_name}}",1,"id","parent_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput2("findFile","entries","name","{{file_name}}",1,"id","file_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput("getFileDetails","sha1","file_sha1")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
If (success <> 1) Then
outFile.WriteLine(curl.LastErrorText)
WScript.Quit
End If
' END ONE-TIME SETUP
' The name lookups below assume each listing fits in one page (1000 items).
' Parent and destination names select root children; folder_name selects a child
' of parent_name. "/" selects the root parent. These are not arbitrary paths.
' BEGIN OPERATION -- keep the configured object when reusing it.
' Inputs are names. Retain cached IDs when the selected names have not changed.
parentName = "/"
folderName = "images"
fileName = "penguins.jpg"
If ((curl.GetVar("parent_name") <> parentName) Or ((parentName = "/") And (curl.VarDefined("parent_id") = 0))) Then
curl.SetVar "parent_name",parentName
curl.ClearVar "parent_id"
curl.ClearVar "folder_id"
curl.ClearVar "file_id"
curl.ClearVar "file_version_id"
curl.ClearVar "file_sha1"
If (parentName = "/") Then
curl.SetVar "parent_id","0"
End If
End If
If (curl.GetVar("folder_name") <> folderName) Then
curl.SetVar "folder_name",folderName
curl.ClearVar "folder_id"
curl.ClearVar "file_id"
curl.ClearVar "file_version_id"
curl.ClearVar "file_sha1"
End If
If (curl.GetVar("file_name") <> fileName) Then
curl.SetVar "file_name",fileName
curl.ClearVar "file_id"
curl.ClearVar "file_version_id"
curl.ClearVar "file_sha1"
End If
curl.SetVar "local_path","qa_output/penguins-verified.jpg"
' file_version_id is also unknown, so getFileDetails becomes a prerequisite.
' Its AddOutput mappings cache both the selected version and its SHA-1.
curl.ClearTargetOutput "*"
set authorizedCommand1 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand1.SetString("curl -X GET ""https://api.box.com/2.0/files/{{file_id}}/content?version={{file_version_id}}"" -H ""Authorization: Bearer {{access_token}}"" -L -o ""{{local_path}}""")
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"))
success = curl.DoYourThing(authorizedCommand1.GetAsString())
If ((success <> 1) Or (curl.StatusCode <> 200)) Then
outFile.WriteLine("Box request failed. HTTP status: " & curl.StatusCode)
outFile.WriteLine("Failure reason: " & curl.FailReason)
outFile.WriteLine(curl.ResponseBodyStr)
WScript.Quit
End If
set digest = CreateObject("Chilkat.Crypt2")
digest.HashAlgorithm = "sha1"
digest.EncodingMode = "hex_lower"
actualSha1 = digest.HashFileENC(curl.GetVar("local_path"))
If (digest.LastMethodSuccess <> 1) Then
outFile.WriteLine(digest.LastErrorText)
WScript.Quit
End If
If (actualSha1 <> curl.GetVar("file_sha1")) Then
outFile.WriteLine("Downloaded content did not match the selected version's SHA-1.")
WScript.Quit
End If
outFile.WriteLine("Version-specific download verified.")
outFile.Close