La mayoría de desarrolladores que utilizamos Team Foundation Server o Visual Studio Team Services - anteriormente VSO - conocemos de la existencia del API REST para acceder la plataforma y poder desarrollar tanto aplicaciones como extensiones de la misma. En este post vamos a ver como acceder este API utilizando la herramienta Postman para pruebas de uso.
Que es Postman?
Postman es una herramienta muy simple de utilizar que nos permite hacer solicitudes de tipo REST ( y muchas otras más) sin necesidad de desarrollar código para probar nuestras API´s. Como se puede ver en la siguiente figura, la herramienta esta disponible tanto para Chrome como para OSX, en mi caso he descargado el aplicativo para Mac y haré las solicitudes desde el mismo. El url para descargar el app es https://getpostman.com.
El API REST de Visual Studio Team Services
El Visual Studio Team Services tiene un API REST que nos permite crear aplicaciones o extensiones que interactúen con la plataforma de Team Foundation tanto "on premises" como "online". El API esta muy bien documentada y se puede acceder en este url.
Hacer solicitudes con Postman
Para hacer solicitudes con postman hacia el API de VSTS simplemente debemos escribir el comando y configurar los parámetros requeridos. Por ejemplo, para solicitar la lista de proyectos en una cuenta específica, tenemos que indicar la cuenta que queremos acceder, el usuario y el password con que queremos acceder y si tenemos varias colecciones debemos solicitar la colección deseada. En este caso, yo quiero acceder una cuenta que tiene el nombre de Arc1Lab, en el defaultCollection y con mi usuario y password de VSTS. En la siguiente figura se ve como se debe configurar la solicitud.
Primero debemos escribir el comando a ejecutar, en este caso es https://arc1lab.VisualStudio.com/DefaultCollection/_apis/projects?api-version=2.0, luego configuramos el tipo de autenticación (1 y 2 ) en este caso básica; seguidamente procedemos a escribir el usuario y el password (3 y 4 ), y por último se envía el comando. El resultado de ejecutar el comando expuesto en la figura anterior se puede ver en la siguiente imagen.
Como se puede ver en la imagen anterior, la lista de proyectos se retorna en formato JSON iniciando con la totalidad de proyectos y luego un detalle de cada proyecto.
