Lua

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. Lua

local chilkat = require("chilkat")

local rest = chilkat.Rest.new()

local success = rest:connect("your.site.domain", 443, true, true)
if not success then
    print(rest.last_error_text)
    return
end

rest:add_header("Cache-Control", "no-cache")

-- The following code creates the JSON request body.
-- The JSON created by this code is shown below.
local jsonReq = chilkat.JsonObject.new()
jsonReq:update_string("grant_type", "password")
jsonReq:update_string("client_id", "sugar")
jsonReq:update_string("client_secret", "CLIENT_SECRET")
jsonReq:update_string("username", "admin")
jsonReq:update_string("password", "password")
jsonReq:update_string("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"
-- }

local sbReq = chilkat.StringBuilder.new()
jsonReq:emit_sb(sbReq)

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

local sbJson = chilkat.StringBuilder.new()
success = rest:full_request_sb("POST", "/rest/v10/oauth2/token", sbReq, sbJson)
if not success then
    print(rest.last_error_text)
    return
end

if rest.response_status_code ~= 200 then
    print("Received error response code: " .. rest.response_status_code)
    print("Response body:")
    print(sbJson:get_as_string())
    return
end

local json = chilkat.JsonObject.new()
json:load_sb(sbJson)

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

local access_token = json:string_of("access_token")
local expires_in = json:int_of("expires_in")
local token_type = json:string_of("token_type")
local scope = json:is_null_of("scope")
local refresh_token = json:string_of("refresh_token")
local refresh_expires_in = json:int_of("refresh_expires_in")
local download_token = json:string_of("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"
-- }

print("Example Completed.")