Exemple : application SOAP moderne de bureau OData
Date de publication : janvier 2017
S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Cet exemple de code est pour Mise à jour de Microsoft Dynamics CRM 2015 et de Microsoft Dynamics CRM Online 2015.Ce code se trouve à l'emplacement suivant dans le package de téléchargement :
SampleCode\CS\ModernAndMobileApps\ModernOdataApp
Téléchargez le package Kit de développement logiciel (SDK) de Microsoft Dynamics CRM.
Configuration requise
Cet exemple nécessite les packages NuGet Microsoft.Preview.WindowsAzure.ActiveDirectory.Authentication et Microsoft.IdentityModel.Clients.ActiveDirectory. Ces packages sont automatiquement téléchargés et installés lorsque vous chargez la solution du projet.
Pour plus d'informations sur les conditions requises pour l'exécution de l'exemple de code fourni dans ce Kit de développement logiciel (SDK), consultez la rubrique Utiliser l’exemple de code et le code d’assistance.
Démontre
.jpeg "Écran principal d'exemples d'applications de Windows 8")
Interface utilisateur en mosaïque de l’exemple de l’application |
Cet exemple indique comment écrire une application moderne de bureau Windows 8.1 qui peut envoyer des requêtes au service Web de l’organisation sans créer de liaison aux assemblys du kit de développement logiciel (SDK). Cet exemple utilise le Bibliothèque d'authentification Microsoft Azure Active Directory et le protocole OData. Alors qu’il existe sept mosaïques affichées sur la page principale de l’application, seules les mosaïques Comptes et Tâches sont connectées au code du gestionnaire des évènements. Les autres mosaïques sont simplement des espaces réservés. L’exemple de code est configuré pour une utilisation avec le serveur Microsoft Dynamics 365 (Online) et une organisation fictive, mais peut être utilisé également avec un serveur IFD. Les extraits de code affichant juste les sections principales de l’exemple complet sont indiqués ultérieurement dans cette rubrique. |
Exemple
L’extrait de code suivant indique comment authentifier l’utilisateur avec le service Web de l’organisation.
using Microsoft.IdentityModel.Clients.ActiveDirectory;
using System;
using System.Threading.Tasks;
using Windows.UI.Popups;
using Windows.Security.Authentication.Web;
using System.Net;
using System.Threading;
using System.IO;
using System.Text;
namespace ModernOdataApp
{
/// <summary>
/// Manages authentication with the organization web service.
/// </summary>
public static class CurrentEnvironment
{
# region Class Level Members
private static AuthenticationContext _authenticationContext;
// TODO Set these string values as approppriate for your app registration and organization.
// For more information, see the SDK topic "Walkthrough: Register an app with Active Directory".
private const string _clientID = "893262be-fbdc-4556-9325-9f863b69495b";
public const string CrmServiceUrl = "https://my-domain.crm.dynamics.com/";
# endregion
// <summary>
/// Perform any required app initialization.
/// This is where authentication with Active Directory is performed.
public static async Task<string> Initialize()
{
Uri serviceUrl = new System.Uri(CrmServiceUrl + "/XRMServices/2011/Organization.svc/web?SdkClientVersion=6.1.0000.0000");
// Dyamics CRM Online OAuth URL.
string _oauthUrl = DiscoveryAuthority(serviceUrl);
// Obtain the redirect URL for the app. This is only needed for app registration.
Uri redirectUri = WebAuthenticationBroker.GetCurrentApplicationCallbackUri();
// Obtain an authentication token to access the web service.
_authenticationContext = new AuthenticationContext(_oauthUrl, false);
AuthenticationResult result = await _authenticationContext.AcquireTokenAsync(CrmServiceUrl, _clientID, redirectUri);
// Verify that an access token was successfully acquired.
if (result.Status != AuthenticationStatus.Success)
{
if (result.Error == "authentication_failed")
{
// Try again.
_authenticationContext = new AuthenticationContext(_oauthUrl, false);
result = await _authenticationContext.AcquireTokenAsync(CrmServiceUrl, _clientID, redirectUri);
}
else
{
DisplayErrorWhenAcquireTokenFails(result);
}
}
return result.AccessToken;
}
/// <summary>
/// Discover the authentication authority.
/// </summary>
/// <param name="serviceUrl">The URL of the organization's SOAP endpoint. </param>
/// <returns>The authority URL.</returns>
/// <remarks>The service URL must contain the SdkClient property.</remarks>
/// <example>https://contoso.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=6.1.0.533;</example>
public static string DiscoveryAuthority(Uri serviceUrl)
{
// Use AuthenticationParameters to send a request to the organization's endpoint and
// receive tenant information in the 401 challenge.
Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters parameters = null;
HttpWebResponse response = null;
try
{
// Create a web request where the authorization header contains the word "Bearer".
HttpWebRequest httpWebRequest = (HttpWebRequest)WebRequest.Create(serviceUrl);
// The response is to be encoded.
httpWebRequest.ContentType = "application/x-www-form-urlencoded";
response = (HttpWebResponse)httpWebRequest.GetResponse();
}
catch (WebException ex)
{
response = (HttpWebResponse)ex.Response;
// A 401 error should be returned. Extract any parameters from the response.
// The response should contain an authorization_uri parameter.
parameters = Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.
CreateFromResponseAuthenticateHeader((response.Headers)["WWW-Authenticate"]);
}
finally
{
if (response != null)
response.Dispose();
}
// Return the authority URL.
return parameters.Authority;
}
/// <summary>
/// Returns a response from an Internet resource.
/// </summary>
public static WebResponse GetResponse(this WebRequest request)
{
AutoResetEvent autoResetEvent = new AutoResetEvent(false);
IAsyncResult asyncResult = request.BeginGetResponse(r => autoResetEvent.Set(), null);
// Wait until the call is finished
autoResetEvent.WaitOne(DefaultRequestTimeout);
return request.EndGetResponse(asyncResult);
}
/// <summary>
/// Get the DefaultRequestTimeout from the server.
/// </summary>
public static TimeSpan DefaultRequestTimeout { get; set; }
/// <summary>
/// Display an error message to the user.
/// </summary>
/// <param name="result">The authentication result returned from AcquireTokenAsync().</param>
private static async void DisplayErrorWhenAcquireTokenFails(AuthenticationResult result)
{
MessageDialog dialog;
switch (result.Error)
{
case "authentication_canceled":
// User cancelled, so no need to display a message.
break;
case "temporarily_unavailable":
case "server_error":
dialog = new MessageDialog("Please retry the operation. If the error continues, please contact your administrator.",
"Sorry, an error has occurred.");
await dialog.ShowAsync();
break;
default:
// An error occurred when acquiring a token so show the error description in a MessageDialog.
dialog = new MessageDialog(string.Format(
"If the error continues, please contact your administrator.\n\nError: {0}\n\nError Description:\n\n{1}",
result.Error, result.ErrorDescription), "Sorry, an error has occurred.");
await dialog.ShowAsync();
break;
}
}
}
}
Pour que ce code fonctionne, vous devez d’abord enregistrer votre application avec un fournisseur d’identité pris en charge (AD FS ou Microsoft Azure Active Directory). Ensuite, vous devez définir des valeurs variables pour _clientID et CrmServiceUrl dans le code. La valeur de l’ID client a été définie au cours de l’inscription de l’application.Pour plus d'informations :Guide pas-à-pas : Enregistrer une application Dynamics 365 auprès d'Active Directory
Exemple
L’extrait du code suivant indique comment récupérer les enregistrements d’entité à partir du service Web de l’organisation en utilisant le code de protocole OData dans une demande HTTP. Le jeton d’accès d’authentification se trouve dans l’en-tête d’autorisation.
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
namespace ModernOdataApp
{
public static class HttpRequestBuilder
{
/// <summary>
/// Retrieve entity record data from the organization web service.
/// </summary>
/// <param name="accessToken">The web service authentication access token.</param>
/// <param name="Columns">The entity attributes to retrieve.</param>
/// <param name="entity">The target entity for which the data should be retreived.</param>
/// <returns>Response from the web service.</returns>
/// <remarks>Builds an OData HTTP request using passed parameters and sends the request to the server.</remarks>
public static async Task<string> Retrieve(string accessToken, string[] Columns, string entity)
{
// Build a list of entity attributes to retrieve as a string.
string columnsSet = "";
foreach (string Column in Columns)
{
columnsSet += "," + Column;
}
// The URL for the OData organization web service.
string url = CurrentEnvironment.CrmServiceUrl + "/XRMServices/2011/OrganizationData.svc/" + entity + "?$select=" + columnsSet.Remove(0, 1) + "";
// Build and send the HTTP request.
HttpClient httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
HttpRequestMessage req = new HttpRequestMessage(HttpMethod.Get, url);
req.Method = HttpMethod.Get;
// Wait for the web service response.
HttpResponseMessage response;
response = await httpClient.SendAsync(req);
var responseBodyAsText = await response.Content.ReadAsStringAsync();
return responseBodyAsText;
}
}
}
Voir aussi
Écrire des applications mobiles et modernes
Bibliothèque d'authentification Azure (AAL) pour Windows Store : étude approfondie
Sécurisation d'une application Windows Store et du service Web REST à l'aide d'Azure AD
OData.org
Microsoft Dynamics 365
© 2017 Microsoft. Tous droits réservés. Copyright