Jorge Serrano
  • Home

Toma de contacto con las APIs de Office 365

  • By jorge
  • Jun-3-2014
  • Sin categoría
  • 0 Comments.

Introducción

Recientemente, Microsoft ha publicado un conjunto de APIs para acceder a Office 365 desde nuestras aplicaciones.

En esta entrada, vamos a introducirnos en el uso y consumo de las APIs de Office 365 desde .NET, en concreto, desde una aplicación de Windows Forms, aunque el tipo de interfaz que usemos no representa en principio ningún problema.

¿Qué nos ofrece las APIs de Office 365?

Las APIs de Office 365 nos ofrece un acceso rápido y sencillo al calendario, correo, contactos, ficheros, etc., de Office 365, reduciendo el tiempo de desarrollo y complejidad a la hora de acceder a estos recursos, abstrayéndonos de ciertas operaciones.

En esta entrada, veremos a modo de prueba de concepto y demostración, como acceder a los contactos de Office 365.

Primeros pasos

Nuestro objetivo principal será el de acceder a las APIs de Office 365 de forma sencilla desde Visual Studio para programar nuestra aplicación.

Para ello, deberemos descargar e instalar en primer lugar (si no lo hemos hecho ya) las Office 365 API Tools para Visual Studio (nota: los ejemplos de código de esta entrada han sido probados con Visual Studio 2013 Update 2).

La descarga de Office 365 API Tools para Visual Studio la encontrarás en este enlace.

Creación de nuestra aplicación

Una vez que hemos instalado las Office 365 API Tools, iniciaremos Visual Studio y crearemos un nuevo proyecto, que en mi caso ha sido un proyecto de Windows Forms al que he puesto por nombre WinFormsOffice365.

A continuación, deberemos hacer clic con el botón derecho del ratón sobre el proyecto que hemos creado y seleccionaremos la opción Add > Connected Service del menú contextual, tal y como aparece en la siguiente imagen:

En la ventana que aparecerá, deberemos conectarnos a nuestra cuenta de Office 365 e indicar sobre qué parte de Office 365 queremos acceder, y los permisos que queremos tener (lectura, escritura, etc).

En esta entrada accederemos a los contactos de nuestra subscripción de Office 365, por lo que he seleccionado el servicio Contacts y le he dado permisos de lectura y escritura.

Los permisos se pueden otorgar seleccionando el servicio al que queremos acceder, y haciendo clic en la opción Permissions.

Una vez modificado todo esto, nuestra ventana debería ser similar a la que se indica a continuación:

Pulsaremos el botón OK y acudiremos al código de nuestra aplicación.

Al realizar esta operación, Visual Studio agrega a nuestro proyecto un conjunto de ensamblados que muy posiblemente necesitemos utilizar a la hora de trabajar con la API de Office 365.

De aquí, los más destacables son:

  • Microsoft.Office365.Exchange
  • Microsoft.Office365.OAuth
  • Microsoft.Office365.OAuth.WindowsForms

Respecto al último, al estar trabajando con una aplicación de Windows Forms, se nos agrega un ensamblado específico del tipo de aplicación con la que estamos trabajando.

Por otro lado, por defecto aparecerá una clase de nombre ContactsApiSample en nuestro código que tendrá el siguiente aspecto:

   1: using Microsoft.Office365.Exchange;

   2: using Microsoft.Office365.OAuth;

   3: using System;

   4: using System.Collections.Generic;

   5: using System.Threading.Tasks;

   6:  

   7: namespace WinFormsOffice365

   8: {

   9:     public static class ContactsAPISample

  10:     {

  11:         const string ExchangeResourceId = "https://outlook.office365.com";

  12:         const string ExchangeServiceRoot = "https://outlook.office365.com/ews/odata";

  13:  

  14:         public static async Task<IEnumerable<IContact>> GetContacts()

  15:         {

  16:             var client = await EnsureClientCreated();

  17:  

  18:             // Obtain first page of contacts

  19:             var contactsResults = await (from i in client.Me.Contacts

  20:                                          orderby i.DisplayName

  21:                                          select i).ExecuteAsync();

  22:             

  23:             return contactsResults.CurrentPage;

  24:         }

  25:     

  26:         private static async Task<ExchangeClient> EnsureClientCreated()

  27:         {

  28:             Authenticator authenticator = new Authenticator();

  29:             var authInfo = await authenticator.AuthenticateAsync(ExchangeResourceId);

  30:  

  31:             return new ExchangeClient(new Uri(ExchangeServiceRoot), authInfo.GetAccessToken);

  32:         }

  33:         public static async Task SignOut()

  34:         {

  35:             await new Authenticator().LogoutAsync();

  36:         }

  37:     }

  38: }

Aunque esta clase nos puede resultar de mucha ayuda, vamos a crear nuestra propia clase con algunas cosas más.

Extendiendo nuestra aplicación

Nuestra aplicación se encargará de mostrar los contactos de nuestra subscripción y de crear nuevos contactos.

En estos momentos, nuestra subscripción tiene un conjunto de contactos tal y como se muestra en la siguiente imagen:

Para darle un poco de gracia a nuestra aplicación Windows, he agregado en ella un conjunto de controles (RichTextBox, Button, Label, LinkLabel, GroupBox, PictureBox…).

La idea como decía antes, es la de permitir mostrar dos acciones principales sobre Office 365 APIs: la posibilidad de acceder y visualizar los contactos de Office 365, y la opción de agregar un nuevo contacto a Office 365.

El aspecto de nuestro formulario Windows es el que se muestra en la siguiente imagen:

Pero lo que realmente nos importa es como podemos trabajar con Office 365 APIs.

Manos a la obra

Para ello, vamos a escribir una clase, que será muy parecida a la que Microsoft nos proporciona en modo prueba y cuyo código compartía anteriormente.

La única salvedad o diferencia es que vamos a agregar alguna instrucción de código más como la inserción de un nuevo contacto y alguna cosa más.

El código de nuestra clase a la que he puesto por nombre Office365Contact es el que se indica a continuación:

   1: using System;

   2: using System.Collections.Generic;

   3: using System.Threading.Tasks;

   4: using Microsoft.Office365.Exchange;

   5: using Microsoft.Office365.OAuth;

   6:  

   7: namespace WinFormsOffice365

   8: {

   9:     public class Office365Contact

  10:     {

  11:  

  12:         private const string ExchangeResourceId = "https://outlook.office365.com";

  13:         private const string ExchangeServiceRoot = "https://outlook.office365.com/ews/odata";

  14:  

  15:         private ExchangeClient _exchangeClient;

  16:  

  17:  

  18:         private bool _isAuthenticated = false;

  19:  

  20:         public bool IsAuthenticated 

  21:         {

  22:             get

  23:             {

  24:                 return _isAuthenticated;

  25:             }

  26:         }

  27:  

  28:  

  29:         private AuthenticationInfo _authenticationInfo;

  30:         public AuthenticationInfo AuthenticationInfo

  31:         {

  32:             get { return _authenticationInfo; }

  33:         }

  34:         

  35:         public async Task<ExchangeClient> EnsureExchangeClient()

  36:         {

  37:             if (_exchangeClient != null)

  38:                 return _exchangeClient;

  39:  

  40:             var authenticator = new Authenticator();

  41:             _authenticationInfo = await authenticator.AuthenticateAsync(ExchangeResourceId);

  42:  

  43:             _exchangeClient = new ExchangeClient(new Uri(ExchangeServiceRoot), _authenticationInfo.GetAccessToken);

  44:             _isAuthenticated = true;

  45:             return _exchangeClient;

  46:         }

  47:  

  48:         public async Task<IEnumerable<IContact>> GetAll()

  49:         {

  50:             var client = await EnsureExchangeClient();

  51:             var contactsResults = await client.Me.Contacts.OrderBy(c => c.DisplayName).ExecuteAsync();

  52:             return contactsResults.CurrentPage;

  53:         }

  54:  

  55:         public async Task Create(Contact contact)

  56:         {

  57:             if (contact == null)

  58:             {

  59:                 throw new ArgumentNullException("contact");

  60:             }

  61:             var client = await EnsureExchangeClient();

  62:             await client.Me.Contacts.AddContactAsync(contact);

  63:         }

  64:  

  65:         public async Task SignOut()

  66:         {

  67:             _isAuthenticated = false;

  68:             await new Authenticator().LogoutAsync();

  69:         }

  70:  

  71:     }

  72:  

  73: }

Atendiendo al código, podemos ver 4 métodos principales:

  • EnsureExchangeClient se encarga de realizar las operaciones de autenticación con Office 365. En el caso de que no estemos autenticados nos aparecerá una ventana para escribir nuestra cuenta de Office 365 y nuestra contraseña. Una vez hecho esto, aparecerá una información que nos solicita que confiemos en las operaciones que dicha aplicación va a realizar y que en nuestro caso será las operaciones de lectura y escritura de contactos. Esta función también sabrá si ya nos hemos autenticado anteriormente con la aplicación.
  • SignOut se encarga por su parte de eliminar los rastros de autenticación de nuestro usuario con la aplicación y forzarnos la próxima vez a volver a tener que escribir nuestra cuenta de Office 365 y aceptar los permisos de la aplicación como si fuera la primera vez que la ejecutáramos.
  • GetAll por su parte, nos permite obtener los contactos de Office 365. En este ejemplo no se ha tenido en cuenta paginación de datos ni nada parecido, y se ha optado por esta porción de código que nos servirá como PoC.
  • Create por último, se encargará de crear un nuevo contacto. Aquí utilizamos un objeto de tipo Contact. Este objeto pertenece al ensamblado Microsoft.Office365.Exchange que ha sido agregado automáticamente por Visual Studio.

Del resto de código, destacar las direcciones web de Office 365 que utilizaremos internamente para conectarnos y trabajar con Office 365.

El código de la aplicación de Windows Forms (o aplicación cliente si utilizamos un poco de abstracción) es aquí poco relevante en cuanto a la gestión interna de lo que hace, pero en términos generales nos permitirá realizar las siguientes acciones: SignIn para autenticarnos, y una vez autenticados, leer los contactos y agregar un nuevo contacto, pudiendo además, cerrar la sesión.

Ejecutando nuestra aplicación

La primera vez que ejecutamos nuestra aplicación obtendremos por lo tanto una pantalla que nos solicitará las credenciales para acceder a Office 365:

Una vez autenticados, obtendremos una segunda ventana para aceptar los permisos que otorgamos a la aplicación para acceder a la información de nuestra cuenta.

Pulsaremos el botón Aceptar.

Una vez hecho esto, nuestra aplicación de Windows Forms tendrá un aspecto similar al siguiente:

La primera operación que llevaremos a cabo será la de leer los contactos de Office 365, para lo cual haremos clic sobre el botón Read Contacts.

Nuestra aplicación tendrá entonces un aspecto similar al que se indica a continuación:

A continuación y por completar nuestro ejemplo o PoC, vamos a agregar datos en los campos que tenemos más abajo para crear un nuevo contacto.

En mi caso he agregado los datos ficticios de una persona llamada Albert Einstein y he pulsado el botón Create.

Una vez hecho, se mostrará nuevamente los contactos incluyendo a Albert.

Si acudimos ahora a Office 365, observaremos que nuestro nuevo contacto ha sido agregado a Office 365.

Recordar que esta PoC no trata de ser un guía o un patrón de cómo trabajar con las APIs de Office 365, sino únicamente una toma de contacto.

El código fuente de todo este ejemplo (cliente incluido) puedes encontrarlo en este enlace.

Conclusiones

Aunque en esta prueba de concepto hemos repasado únicamente las operaciones de lectura y obtención de todos los contactos, y de creación de un contacto en Office 365, podríamos haber llevado a cabo todas las operaciones CRUD.

También cabe destacar que en nuestro caso, hemos realizado operaciones con los contactos de un usuario, pero podríamos haber realizado operaciones con el calendario, correo, ficheros, etc.

Happy coding!

Comments

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.