PureBasic
PureBasic
Dynamics CRM OAuth2 Access Token
See more OAuth2 Examples
Demonstrates how to get a Microsoft Dynamics CRM OAuth2 access token from a desktop (installed) application or script.Chilkat PureBasic Downloads
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkFileAccess.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkOAuth2.pb"
Procedure ChilkatExample()
success.i = 0
; To further clarify, see OAuth 2.0 Authorization Flow
oauth2.i = CkOAuth2::ckCreate()
If oauth2.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; This should be the port in the localhost redirect URL for your app.
; Important: Make sure the redirect URI in your Azure app registration
; is exactly "http://localhost:3017/". Don't forget the ending "/" char.
; The redirect URL would look like "http://localhost:3017/" if the port number is 3017.
CkOAuth2::setCkListenPort(oauth2, 3017)
; Get the endpoints from the Azure Portal in the "endpoints" section of App Registrations..
; The DYNAMICS-ENDPOINT-GUID is a Tenant dynamics-endpoint-guid such as 1b54e7ee-d61b-4f12-a621-a6b2805b98c2
CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize")
CkOAuth2::setCkTokenEndpoint(oauth2, "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token")
; Replace these with actual values.
CkOAuth2::setCkClientId(oauth2, "DYNAMICS-CRM-CLIENT-ID")
CkOAuth2::setCkClientSecret(oauth2, "DYNAMICS-CRM-SECRET-KEY")
CkOAuth2::setCkResource(oauth2, "https://mydynamicsdomain.api.crm.dynamics.com")
CkOAuth2::setCkRedirectAllowHtml(oauth2, "<html><body><p>Thank you for granting access.</p></bod></html>")
CkOAuth2::setCkRedirectDenyHtml(oauth2, "<html><body><p>Maybe next time...</p></bod></html>")
; Begin the OAuth2 Authorization code flow. This returns a URL that should be loaded in a browser.
url.s = CkOAuth2::ckStartAuth(oauth2)
If CkOAuth2::ckLastMethodSuccess(oauth2) <> 1
Debug CkOAuth2::ckLastErrorText(oauth2)
CkOAuth2::ckDispose(oauth2)
ProcedureReturn
EndIf
; We can pre-check the URL by sending a GET to catch any up-front errors.
; If we receive JSON with an error in response, then we don't proceed any farther.
; If we receive an HTML response, and the response status = 200, then all should be OK.
; We can proceed by displaying an interactive browser loaded with the url.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sbPreCheck.i = CkStringBuilder::ckCreate()
If sbPreCheck.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,url,sbPreCheck)
If (CkHttp::ckLastStatus(http) <> 200) OR (CkStringBuilder::ckStartsWith(sbPreCheck,"{",1) <> 1)
Debug "JSON Error Response:"
Debug CkStringBuilder::ckGetAsString(sbPreCheck)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
; If the HTTP request itself failed, then examine the error.
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
; OK.. the pre-flight check seems OK, go ahead with getting the interactive user authorization..
; Launch the default browser on the system and navigate to the url.
; The LaunchBrowser method was added in Chilkat v10.1.2.
success = CkOAuth2::ckLaunchBrowser(oauth2,url)
If success = 0
Debug CkOAuth2::ckLastErrorText(oauth2)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
; Wait for the user to approve or deny authorization in the browser.
numMsWaited.i = 0
While (numMsWaited < 90000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
CkOAuth2::ckSleepMs(oauth2,100)
numMsWaited = numMsWaited + 100
Wend
; If the browser does not respond within the specified time, AuthFlowState will be:
;
; 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
; 2: Waiting for Final Response – The thread is awaiting the final access token response.
; In either case, cancel the background task initiated by StartAuth.
If CkOAuth2::ckAuthFlowState(oauth2) < 3
CkOAuth2::ckCancel(oauth2)
Debug "No response from the browser!"
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
; Check AuthFlowState to determine if authorization was granted, denied, or failed:
;
; 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
; 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
; 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.
If CkOAuth2::ckAuthFlowState(oauth2) = 5
Debug "OAuth2 failed to complete."
Debug CkOAuth2::ckFailureInfo(oauth2)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
If CkOAuth2::ckAuthFlowState(oauth2) = 4
Debug "OAuth2 authorization was denied."
Debug CkOAuth2::ckAccessTokenResponse(oauth2)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
If CkOAuth2::ckAuthFlowState(oauth2) <> 3
Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
ProcedureReturn
EndIf
Debug "OAuth2 authorization granted!"
Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)
; Get the full JSON response:
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoad(json,CkOAuth2::ckAccessTokenResponse(oauth2))
CkJsonObject::setCkEmitCompact(json, 0)
; The JSON response looks like this:
; {
; "token_type": "Bearer",
; "scope": "user_impersonation",
; "expires_in": "3599",
; "ext_expires_in": "0",
; "expires_on": "1524783438",
; "not_before": "1524779538",
; "resource": "https://mydomain.api.crm.dynamics.com",
; "access_token": "...",
; "refresh_token": "...",
; "id_token": "..."
; }
; If an "expires_on" member does not exist, then add the JSON member by
; getting the current system date/time and adding the "expires_in" seconds.
; This way we'll know when the token expires.
If CkJsonObject::ckHasMember(json,"expires_on") <> 1
dtExpire.i = CkDateTime::ckCreate()
If dtExpire.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkDateTime::ckSetFromCurrentSystemTime(dtExpire)
CkDateTime::ckAddSeconds(dtExpire,CkJsonObject::ckIntOf(json,"expires_in"))
CkJsonObject::ckAppendString(json,"expires_on",CkDateTime::ckGetAsUnixTimeStr(dtExpire,0))
EndIf
Debug CkJsonObject::ckEmit(json)
; Save the JSON to a file for future requests.
fac.i = CkFileAccess::ckCreate()
If fac.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/dynamicsCrm.json",CkJsonObject::ckEmit(json),"utf-8",0)
CkOAuth2::ckDispose(oauth2)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbPreCheck)
CkJsonObject::ckDispose(json)
CkDateTime::ckDispose(dtExpire)
CkFileAccess::ckDispose(fac)
ProcedureReturn
EndProcedure