PureBasic

Xero Get File Content (Files API)

Demonstrates how to download the content of a Xero file.

Note: This example requires Chilkat v9.5.0.64 or greater.

PureBasic

IncludeFile "CkBinData.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

    ; Note: Requires Chilkat v9.5.0.64 or greater.

    ; This requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Before sending REST API calls, the REST object needs to be
    ; initialized for OAuth1.
    ; See Xero 2-Legged OAuth1 Setup for sample code.

    ; Assuming the REST object's OAuth1 authenticator is setup, and the initial
    ; connection was made, we may now send REST HTTP requests..

    ; ------------------------------------------------------------------------------
    fileID.s = "f042e9a3-a31d-4595-b8b3-6030ea6084bb"

    sbPath.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/files.xro/1.0/Files/{FileId}/Content")
    numReplaced.i = CkStringBuilder::ckReplace(sbPath,"{FileId}",fileID)

    jpgData.i = CkBinData::ckCreate()
    If jpgData.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodyBd(rest,"GET",CkStringBuilder::ckGetAsString(sbPath),jpgData)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkBinData::ckDispose(jpgData)
        ProcedureReturn
    EndIf

    ; A 200 response is expected for actual success.
    ; If we don't get a 200 response, then the response body was not actually
    ; the file data, but it was text containing error information.
    If CkRest::ckResponseStatusCode(rest) <> 200
        sbErrorText.i = CkStringBuilder::ckCreate()
        If sbErrorText.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkStringBuilder::ckAppendBd(sbErrorText,jpgData,"utf-8",0,0)
        Debug CkStringBuilder::ckGetAsString(sbErrorText)
        Debug "-- Failed."
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkBinData::ckDispose(jpgData)
        CkStringBuilder::ckDispose(sbErrorText)
        ProcedureReturn
    EndIf

    ; Save to a local file.
    success = CkBinData::ckWriteFile(jpgData,"qa_output/xero_penguins.jpg")
    If success <> 1
        Debug "Failed to save to local file."
    EndIf

    Debug "Xero Get File was Successful."


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbPath)
    CkBinData::ckDispose(jpgData)
    CkStringBuilder::ckDispose(sbErrorText)


    ProcedureReturn
EndProcedure