(PureBasic) SugarCRM Authenticate

Demonstrates how to authenticate to the SugarCRM REST v10 API. This is how an OAuth2 access token is obtained.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    success.i

    success = CkRest::ckConnect(rest,"your.site.domain",443,1,1)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckAddHeader(rest,"Cache-Control","no-cache")

    ; The following code creates the JSON request body.
    ; The JSON created by this code is shown below.
    jsonReq.i = CkJsonObject::ckCreate()
    If jsonReq.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonReq,"grant_type","password")
    CkJsonObject::ckUpdateString(jsonReq,"client_id","sugar")
    CkJsonObject::ckUpdateString(jsonReq,"client_secret","CLIENT_SECRET")
    CkJsonObject::ckUpdateString(jsonReq,"username","admin")
    CkJsonObject::ckUpdateString(jsonReq,"password","password")
    CkJsonObject::ckUpdateString(jsonReq,"platform","custom_api")

    ; The JSON request body created by the above code:

    ; {
    ;   "grant_type": "password",
    ;   "client_id": "sugar",
    ;   "client_secret": "CLIENT_SECRET",
    ;   "username": "admin",
    ;   "password": "password",
    ;   "platform": "custom_api"
    ; }

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

    CkJsonObject::ckEmitSb(jsonReq,sbReq)

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

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

    success = CkRest::ckFullRequestSb(rest,"POST","/rest/v10/oauth2/token",sbReq,sbJson)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonReq)
        CkStringBuilder::ckDispose(sbReq)
        CkStringBuilder::ckDispose(sbJson)
        ProcedureReturn
    EndIf

    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Received error response code: " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response body:"
        Debug CkStringBuilder::ckGetAsString(sbJson)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonReq)
        CkStringBuilder::ckDispose(sbReq)
        CkStringBuilder::ckDispose(sbJson)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoadSb(json,sbJson)

    ; The following code parses the JSON response.
    ; A sample JSON response is shown below the sample code.
    access_token.s
    expires_in.i
    token_type.s
    scope.i
    refresh_token.s
    refresh_expires_in.i
    download_token.s

    access_token = CkJsonObject::ckStringOf(json,"access_token")
    expires_in = CkJsonObject::ckIntOf(json,"expires_in")
    token_type = CkJsonObject::ckStringOf(json,"token_type")
    scope = CkJsonObject::ckIsNullOf(json,"scope")
    refresh_token = CkJsonObject::ckStringOf(json,"refresh_token")
    refresh_expires_in = CkJsonObject::ckIntOf(json,"refresh_expires_in")
    download_token = CkJsonObject::ckStringOf(json,"download_token")

    ; A sample JSON response body that is parsed by the above code:

    ; {
    ;   "access_token": "c6d495c9-bb25-81d2-5f81-533ef6479f9b",
    ;   "expires_in": 3600,
    ;   "token_type": "bearer",
    ;   "scope": null,
    ;   "refresh_token": "cbc40e67-12bc-4b56-a1d9-533ef62f2601",
    ;   "refresh_expires_in": 1209600,
    ;   "download_token": "cc5d1a9f-6627-3349-96e5-533ef6b1a493"
    ; }

    Debug "Example Completed."


    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(jsonReq)
    CkStringBuilder::ckDispose(sbReq)
    CkStringBuilder::ckDispose(sbJson)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure