Sample code for 30+ languages & platforms
Lianja

SugarCRM Authenticate

See more SugarCRM Examples

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

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

loRest = createobject("CkRest")

llSuccess = loRest.Connect("your.site.domain",443,.T.,.T.)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

loRest.AddHeader("Cache-Control","no-cache")

// The following code creates the JSON request body.
// The JSON created by this code is shown below.
loJsonReq = createobject("CkJsonObject")
loJsonReq.UpdateString("grant_type","password")
loJsonReq.UpdateString("client_id","sugar")
loJsonReq.UpdateString("client_secret","CLIENT_SECRET")
loJsonReq.UpdateString("username","admin")
loJsonReq.UpdateString("password","password")
loJsonReq.UpdateString("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"
// }

loSbReq = createobject("CkStringBuilder")
loJsonReq.EmitSb(loSbReq)

loRest.AddHeader("Content-Type","application/json")

loSbJson = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestSb("POST","/rest/v10/oauth2/token",loSbReq,loSbJson)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loJsonReq
    release loSbReq
    release loSbJson
    return
endif

if (loRest.ResponseStatusCode <> 200) then
    ? "Received error response code: " + str(loRest.ResponseStatusCode)
    ? "Response body:"
    ? loSbJson.GetAsString()
    release loRest
    release loJsonReq
    release loSbReq
    release loSbJson
    return
endif

loJson = createobject("CkJsonObject")
loJson.LoadSb(loSbJson)

// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.

lcAccess_token = loJson.StringOf("access_token")
lnExpires_in = loJson.IntOf("expires_in")
lcToken_type = loJson.StringOf("token_type")
llScope = loJson.IsNullOf("scope")
lcRefresh_token = loJson.StringOf("refresh_token")
lnRefresh_expires_in = loJson.IntOf("refresh_expires_in")
lcDownload_token = loJson.StringOf("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"
// }

? "Example Completed."


release loRest
release loJsonReq
release loSbReq
release loSbJson
release loJson