PureBasic Requires Chilkat v11.7.0+

Box: Set Up Reusable HttpCurl Requests and Outputs

See more Box Examples

Register searchFolder and searchFile once, with deferred folder_name and file_name output rules. This review example resolves a folder directly under root and a file directly inside it. The download operation requires exactly one search result at each step and validates exact names and parent IDs. Registration and ExaminePlan send no requests. Other Box examples still have their existing standalone setups.

See the Box API guide for setup and the complete workflow.

PureBasic

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpCurl.pb"

Procedure ChilkatExample()

    success.i = 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
    ;  Requires Chilkat 11.7.0. Registration sends no requests.
    ;  Run this once and keep the SAME HttpCurl object for later downloads.
    ;  This focused setup searches for a root folder and a file directly inside it.
    curl.i = CkHttpCurl::ckCreate()
    If curl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpCurl::ckSetVar(curl,"access_token","BOX_ACCESS_TOKEN")
    setupCommand.i = CkStringBuilder::ckCreate()
    If setupCommand.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    setupReplacements.i

    ;  searchFolder: Box searches names; quotes request a phrase match.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/search?query={{folder_query}}&type=folder&content_types=name&fields=id,type,name,parent&limit=2" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"searchFolder",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Deferred selection: folder_name need not be set during setup.
    success = CkHttpCurl::ckAddOutput2(curl,"searchFolder","entries","name","{{folder_name}}",1,"id","folder_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"searchFolder","entries","name","{{folder_name}}",1,"name","folder_result_name")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"searchFolder","entries","name","{{folder_name}}",1,"parent.id","folder_parent_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput(curl,"searchFolder","total_count","folder_search_count")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  searchFile: Box searches names; quotes request a phrase match.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/search?query={{file_query}}&type=file&content_types=name&fields=id,type,name,parent&limit=2&ancestor_folder_ids={{folder_id}}" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"searchFile",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Deferred selection: file_name need not be set during setup.
    success = CkHttpCurl::ckAddOutput2(curl,"searchFile","entries","name","{{file_name}}",1,"id","file_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"searchFile","entries","name","{{file_name}}",1,"name","file_result_name")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"searchFile","entries","name","{{file_name}}",1,"parent.id","file_parent_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput(curl,"searchFile","total_count","file_search_count")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  END ONE-TIME SETUP
    ;  Search is indexed: newly uploaded/renamed items may not appear immediately.
    ;  Search matches phrases, not exact strings, and ancestor filtering includes
    ;  subfolders. The operation validates counts, exact names, and immediate parents.
    ;  limit=2 is enough to demonstrate an ambiguous search; total_count covers all
    ;  results, not just this page. This introductory example requires exactly one
    ;  search result at each step and does not select among multiple candidates.

    ;  BEGIN OPERATION -- use the previously configured object.
    ;  Human-readable inputs. No resource IDs are supplied by the caller.
    folderName.s = "images"
    fileName.s = "penguins.jpg"
    ;  Encode the quoted search queries separately from the literal output filters.
    ;  In this build, URL variable substitution does not encode '&' in a name.
    queryText.i = CkStringBuilder::ckCreate()
    If queryText.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckSetString(queryText,Chr(34))
    CkStringBuilder::ckAppend(queryText,folderName)
    CkStringBuilder::ckAppend(queryText,Chr(34))
    CkHttpCurl::ckSetVar(curl,"folder_query",CkStringBuilder::ckGetEncoded(queryText,"url","utf-8"))
    CkStringBuilder::ckSetString(queryText,Chr(34))
    CkStringBuilder::ckAppend(queryText,fileName)
    CkStringBuilder::ckAppend(queryText,Chr(34))
    CkHttpCurl::ckSetVar(curl,"file_query",CkStringBuilder::ckGetEncoded(queryText,"url","utf-8"))
    If CkHttpCurl::ckGetVar(curl,"folder_name") <> folderName
        CkHttpCurl::ckClearVar(curl,"folder_id")
        CkHttpCurl::ckClearVar(curl,"folder_result_name")
        CkHttpCurl::ckClearVar(curl,"folder_parent_id")
        CkHttpCurl::ckClearVar(curl,"folder_search_count")
        CkHttpCurl::ckClearVar(curl,"file_id")
        CkHttpCurl::ckClearVar(curl,"file_result_name")
        CkHttpCurl::ckClearVar(curl,"file_parent_id")
        CkHttpCurl::ckClearVar(curl,"file_search_count")
        CkHttpCurl::ckSetVar(curl,"folder_name",folderName)
    EndIf

    If CkHttpCurl::ckGetVar(curl,"file_name") <> fileName
        CkHttpCurl::ckClearVar(curl,"file_id")
        CkHttpCurl::ckClearVar(curl,"file_result_name")
        CkHttpCurl::ckClearVar(curl,"file_parent_id")
        CkHttpCurl::ckClearVar(curl,"file_search_count")
        CkHttpCurl::ckSetVar(curl,"file_name",fileName)
    EndIf

    ;  With unchanged names, cached IDs and validation fields can be reused.
    ;  Clear the corresponding cached fields to refresh after a remote rename/move.
    ;  Examine the plan without running any HTTP requests.
    setupPlan.i = CkJsonObject::ckCreate()
    If setupPlan.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(setupPlan, 0)
    authorizedCommand1.i = CkStringBuilder::ckCreate()
    If authorizedCommand1.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckSetString(authorizedCommand1,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/files/{{file_id}}/content" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer {{access_token}}" + Chr(34) + " -L")
    headerReplacement1.i = CkStringBuilder::ckReplace(authorizedCommand1,"{{access_token}}",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckExaminePlan(curl,CkStringBuilder::ckGetAsString(authorizedCommand1),setupPlan)
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(queryText)
        CkJsonObject::ckDispose(setupPlan)
        CkStringBuilder::ckDispose(authorizedCommand1)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(setupPlan)
    Debug "Keep this HttpCurl object for the search-based download operation."


    CkHttpCurl::ckDispose(curl)
    CkStringBuilder::ckDispose(setupCommand)
    CkStringBuilder::ckDispose(queryText)
    CkJsonObject::ckDispose(setupPlan)
    CkStringBuilder::ckDispose(authorizedCommand1)


    ProcedureReturn
EndProcedure