Harvest(考勤卡应用)API

时间:2011-04-28 16:19:58

标签: c# api harvest

Harvest是我在工作中使用的时间跟踪应用程序。虽然Web UI非常简单,但我想添加一些自定义功能。我注意到他们有一个API ...所以我想在C#中创建一个自定义桌面客户端。

只看页面,它的信息量不大。您可以找到的C#示例(在进行一些挖掘之后)也没有多大帮助。那么......我在世界上如何使用C#API?

Link to API page

非常感谢任何帮助:)

2 个答案:

答案 0 :(得分:7)

Harvest正在使用REST API,那么您对服务器上的Web地址执行get / put / post请求是什么,它将返回结果(通常以XML或{{3}格式化) (在这种情况下似乎是XML))。 Google快速搜索返回JSON有关如何使用REST API的信息,希望这足以满足您的需求。如果没有,请随时向我们询问您使用REST和C#

时遇到的具体问题

在这里,我将尝试在他们的样本中添加更多评论

using System;
using System.Net;
using System.IO;
using System.Text;
using System.Security.Cryptography.X509Certificates;
using System.Net.Security;

class HarvestSample
{
   //This is used to validate the certificate the server gives you, it allays assumes the cert is valid.
   public static bool Validator (object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) {
     return true;
   }

   static void Main(string[] args)
   {
      //setting up the initial request.
      HttpWebRequest request;
      HttpWebResponse response = null;
      StreamReader reader;
      StringBuilder sbSource;
      // 1. Set some variables specific to your account.
      //This is the URL that you will be doing your REST call against. think of it as a function in normal library.
      string uri = "https://yoursubdomain.harvestapp.com/projects";
      string username="youremail@somewhere.com";
      string password="yourharvestpassword";
      string usernamePassword = username + ":" + password;

      //This checks the SSL cert that the server will give us, the function is above this one.
      ServicePointManager.ServerCertificateValidationCallback = Validator;

      try
      {
         //more setup of the connection
         request = WebRequest.Create(uri) as HttpWebRequest;
         request.MaximumAutomaticRedirections = 1;
         request.AllowAutoRedirect = true;

         // 2. It's important that both the Accept and ContentType headers are
         // set in order for this to be interpreted as an API request.
         request.Accept = "application/xml";
         request.ContentType = "application/xml";
         request.UserAgent = "harvest_api_sample.cs";
         // 3. Add the Basic Authentication header with username/password string.
         request.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(new ASCIIEncoding().GetBytes(usernamePassword)));
         //actually perform the GET request
         using (response = request.GetResponse() as HttpWebResponse)
         {
            //Parse out the XML it returned.
            if (request.HaveResponse == true && response != null)
            {
               reader = new StreamReader(response.GetResponseStream(), Encoding.UTF8);
               sbSource = new StringBuilder(reader.ReadToEnd());
               // 4. Print out the XML of all projects for this account.
               Console.WriteLine(sbSource.ToString());
            }
         }
      }
      catch (WebException wex)
      {
         if (wex.Response != null)
         {
            using (HttpWebResponse errorResponse = (HttpWebResponse)wex.Response)
            {
               Console.WriteLine(
                     "The server returned '{0}' with the status code {1} ({2:d}).",
                     errorResponse.StatusDescription, errorResponse.StatusCode,
                     errorResponse.StatusCode);
            }
         } else {
               Console.WriteLine( wex);

}
      } finally {
         if (response != null) { response.Close(); }
      }
   }
}

答案 1 :(得分:2)

我也在努力使用他们的API。斯科特的答案非常有用。

无论如何,有一个非常有用且简单的库,在NuGet中可以找到名为EasyHttp的女巫。 这是与斯科特相同的方法,但更短:):

public static string getProjects()
    {

        string uri = "https://<companyname>.harvestapp.com/projects";
        HttpClient http = new HttpClient();
        //Http Header
        http.Request.Accept = HttpContentTypes.ApplicationJson;
        http.Request.ContentType = HttpContentTypes.ApplicationJson;
        http.Request.SetBasicAuthentication(username, password);
        http.Request.ForceBasicAuth = true;
        HttpResponse response = http.Get(uri);

        return response.RawText;        
    }

如果您想了解有关WebApi调用的更多信息,可以使用Fidler或更简单的RestClient这是一个Firefox插件。

使用RestClient,您可以直接与休息服务器通信,如果您想了解RESTful服务,这将非常有用。