Dynamics CRM Online 2015 Update 1 新機能: Web API 開発者プレビュー その 1

みなさん、こんにちは。

今回から Dynamics CRM Online 2015 Update 1 で提供される新機能より
Web API 開発者プレビューを紹介します。

概要

Microsoft Dynamics CRM は開発者向けに SOAP と REST エンドポイント
を提供してきましたが、今回新しく Web API エンドポイントが追加され
ました。現時点ではプレビューという位置づけです。

Web API エンドポイントは OData 4 をサポートしており、これまでの
REST エンドポイントがサポートしていた CRUD (Create/Read/Update/
Delete) に加え多くの Action と Function (組織サービスの実行等) が
提供されます。これは将来的に SOAP エンドポイントを置き換える事が
出来るもので、より Web 開発の標準に沿ったものです。

機能は既定で無効となっています。

機能の有効化

Web API 開発者プレビューは以下の手順で有効にできます。

1. ブラウザで Dynamics CRM Online に接続します。

2. 設定 | 管理 | システムの設定よりプレビュータブを開きます。

3. ライセンス状況を読んでいただき、「ライセンス状況を読んで同意する」
にチェックをします。プレビュー機能のため、開発およびテスト環境で
お試しいただくことを推奨します。

4. 「Dynamics CRM Web API のプレビューを有効にする」項目で左側の
チェックを入れます。※「無効化する」というラベルは「はい」の誤訳です。
次期パッチにて修正予定です。

5. 「OK」をクリックします。

データの取得

今回はまず簡単にデータの取得を試してみます。Web API エンドポイント
は以下の URL からアクセスできます。こちらの URL は開発者リソースには
出ていません。
※ 以下 URL の crm7 は環境によって変わります。

https://<組織名>.crm7.dynamics.com/api/data

1. 一旦 Dynamics CRM Online にブラウザで接続してから、以下の URL
にアクセスします。

https://<組織名>.crm7.dynamics.com/api/data/accounts

2. Internet Explorer の場合は結果をダウンロードできます。Chrome を
お使いの場合は、結果が画面に表示されます。

3. 特定のレコードを取得する場合は以下の URL を利用します。レコードの
Guid をそのまま渡すだけです。

https://<組織名>.crm7.dynamics.com/api/data/accounts(21e50903-900f-e511-80db-c4346bc42d18)

4. 多くの OData クエリをサポートしているため、以下のように Select や
Filter が利用できます。

https://<組織名>.crm7.dynamics.com/api/data/accounts?$select=name&$filter=statuscode -eq 0

認証

Web API は OAuth 2.0 認証をサポートします。開発するプログラムから
アクセスする場合は、Azure AD を利用した OAuth 2.0 認証が必須です。

まとめ

Web API は今後の開発の基本となる重要な機能です。まだプレビュー
ですが、是非お試しください。尚、設置型 の Dynamics CRM 2015 に
対するプレビュー機能提供の予定は現時点ではありません。

次回から具体的な利用方法を紹介していきます。お楽しみに!

参考URL
https://msdn.microsoft.com/en-us/dynamics/crm/webapipreview.aspx

- 中村 憲一郎