Chilkat Online Tools

PureBasic / New FreshBooks / Modify existing application

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

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

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "name": "<app_name>",
    ;   "client_secret": "<app client secret>",
    ;   "redirect_uri": "<app redirect uri>",
    ;   "description": "<app descripttion>",
    ;   "website_url": "<link to app website>",
    ;   "settings_url": "<link to app settings>",
    ;   "logo_public_id": "<jwt returned from post https://api.freshbooks.com/uploads/images>"
    ; }

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

    CkJsonObject::ckUpdateString(json,"name","<app_name>")
    CkJsonObject::ckUpdateString(json,"client_secret","<app client secret>")
    CkJsonObject::ckUpdateString(json,"redirect_uri","<app redirect uri>")
    CkJsonObject::ckUpdateString(json,"description","<app descripttion>")
    CkJsonObject::ckUpdateString(json,"website_url","<link to app website>")
    CkJsonObject::ckUpdateString(json,"settings_url","<link to app settings>")
    CkJsonObject::ckUpdateString(json,"logo_public_id","<jwt returned from post https://api.freshbooks.com/uploads/images>")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{ 
   "name": "<app_name>",
   "client_secret":"<app client secret>",
   "redirect_uri":"<app redirect uri>",
   "description":"<app descripttion>",
   "website_url":"<link to app website>",
   "settings_url":"<link to app settings>",
   "logo_public_id":"<jwt returned from post https://api.freshbooks.com/uploads/images>"
}'
https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>

Postman Collection Item JSON

{
  "name": "Modify existing application",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{ \n   \"name\": \"<app_name>\",\n   \"client_secret\":\"<app client secret>\",\n   \"redirect_uri\":\"<app redirect uri>\",\n   \"description\":\"<app descripttion>\",\n   \"website_url\":\"<link to app website>\",\n   \"settings_url\":\"<link to app settings>\",\n   \"logo_public_id\":\"<jwt returned from post https://api.freshbooks.com/uploads/images>\"\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "auth",
        "api",
        "v1",
        "partners",
        "applications",
        "<app_client_id>"
      ]
    }
  },
  "response": [
  ]
}