Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(PureBasic) Xero Upload File (Files API)Demonstrates how to upload a file to a Xero folder. Note: This example requires Chilkat v9.5.0.64 or greater.
IncludeFile "CkBinData.pb" IncludeFile "CkHttp.pb" IncludeFile "CkStringBuilder.pb" IncludeFile "CkJsonObject.pb" IncludeFile "CkRest.pb" Procedure ChilkatExample() ; 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 success.i ; 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.. ; -------------------------------------------------------------- ; This example will upload a file to a folder using the Xero FILES API folderID.s = "0ffca059-f2f1-4271-8de9-4b87c8c2c638" ; This JPG image can be downloaded from https://www.chilkatsoft.com/syncedImages/penguins.jpg filename.s = "penguins.jpg" sbPath.i = CkStringBuilder::ckCreate() If sbPath.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkStringBuilder::ckAppend(sbPath,"/files.xro/1.0/Files/{FolderId}") numReplaced.i = CkStringBuilder::ckReplace(sbPath,"{FolderId}",folderID) CkRest::ckAddHeader(rest,"Content-Type","image/jpeg") ; Load the JPG image from a file. jpgData.i = CkBinData::ckCreate() If jpgData.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkBinData::ckLoadFile(jpgData,"qa_data/jpg/penguins.jpg") ; We could alternatively get it from a URL like this: jpgDataFromWeb.i = CkBinData::ckCreate() If jpgDataFromWeb.i = 0 Debug "Failed to create object." ProcedureReturn EndIf http.i = CkHttp::ckCreate() If http.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkHttp::ckQuickGetBd(http,"https://www.chilkatsoft.com/syncedImages/penguins.jpg",jpgDataFromWeb) If success <> 1 Debug CkHttp::ckLastErrorText(http) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbPath) CkBinData::ckDispose(jpgData) CkBinData::ckDispose(jpgDataFromWeb) CkHttp::ckDispose(http) ProcedureReturn EndIf ; ; Put the file data in the 1st sub-part in the multipart/form-data request we'll be sending. CkRest::setCkPartSelector(rest, "1") CkRest::ckSetMultipartBodyBd(rest,jpgData) ; Set request headers in the 1st subpart (as indicated by the PartSelector) CkRest::ckAddHeader(rest,"Content-Type","image/jpeg") CkRest::ckAddHeader(rest,"Content-Disposition","multipart/form-data; name=Xero; filename=penguins.jpg") ; Restore the PartSelector to an empty string. CkRest::setCkPartSelector(rest, "") CkRest::ckAddHeader(rest,"Content-Type","multipart/form-data") ; Upload with a multipart/form-data POST responseJson.s = CkRest::ckFullRequestMultipart(rest,"POST",CkStringBuilder::ckGetAsString(sbPath)) If CkRest::ckLastMethodSuccess(rest) <> 1 Debug CkRest::ckLastErrorText(rest) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbPath) CkBinData::ckDispose(jpgData) CkBinData::ckDispose(jpgDataFromWeb) CkHttp::ckDispose(http) ProcedureReturn EndIf json.i = CkJsonObject::ckCreate() If json.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::ckLoad(json,responseJson) CkJsonObject::setCkEmitCompact(json, 0) ; A 201 response is expected for actual success. ; The Xero documentation doesn't explicitly state it, but that's what we've found in testing. ; To be safe, we'll check for either 200 or 201. If (CkRest::ckResponseStatusCode(rest) <> 200) AND (CkRest::ckResponseStatusCode(rest) <> 201) Debug CkJsonObject::ckEmit(json) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbPath) CkBinData::ckDispose(jpgData) CkBinData::ckDispose(jpgDataFromWeb) CkHttp::ckDispose(http) CkJsonObject::ckDispose(json) ProcedureReturn EndIf ; Examine the JSON response Debug CkJsonObject::ckEmit(json) ; A successful response looks like this: ; { ; "Name": "penguins.jpg", ; "MimeType": "image/jpeg", ; "Size": 777835, ; "CreatedDateUtc": "2016-11-12T15:31:53.4230000", ; "UpdatedDateUtc": "2016-11-12T15:31:53.4230000", ; "User": { ; "Name": "admin@chilkatsoft.com", ; "FirstName": "Matthew", ; "LastName": "Smith", ; "FullName": "Matthew Smith", ; "Id": "c362fe42-cb12-461f-b84a-c281c1a74841" ; }, ; "FolderId": "0ffca059-f2f1-4271-8de9-4b87c8c2c638", ; "Id": "f042e9a3-a31d-4595-b8b3-6030ea6084bb" ; } CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbPath) CkBinData::ckDispose(jpgData) CkBinData::ckDispose(jpgDataFromWeb) CkHttp::ckDispose(http) CkJsonObject::ckDispose(json) ProcedureReturn EndProcedure |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.