Harvest是我在工作中使用的时间跟踪应用程序。虽然 Web UI 非常简单,但我想添加一些自定义功能。我注意到他们有一个API ......所以我想用 C# 为它制作一个自定义桌面客户端。
只看页面,信息量不大。您可以找到的 C# 示例(在进行了一些挖掘之后)也没有多大帮助。那么......我到底如何将 API 与 C# 一起使用?
任何帮助将不胜感激 :)
Harvest 使用的是REST API,所以你要做的是向服务器上的网址发出 get/put/post 请求,它会返回一个结果(通常格式为 XML 或JSON(在这种情况下似乎是 XML) )。一个快速的谷歌搜索返回了这个关于如何使用 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(); }
}
}
}
我也为他们的 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,您可以直接与 REST 服务器对话,如果您想了解 RESTful 服务,这将非常有帮助。