我为 Highrise 的 API 编写了一个非常基本的包装类。它非常适合读取(GET),我刚刚开始测试它的创建(POST)。据我所知,这两个请求(一个在命令行上,一个通过 PHP 的 cURL 库)是相同的。相同的 XML,相同的选项集....只有一个有效,而另一个无效。
任何帮助表示赞赏。我也将这个问题发布到 37signals 开发者邮件列表,但是 stackoverflow 通常更快地发现我的愚蠢错误......
这是我在使用 PHP 的 cURL 时遇到的错误(让我认为 Highrise 在解析 XML 字符串时遇到了问题):
<?xml version="1.0" encoding="UTF-8"?> <errors> <error>First name can't be blank</error> </errors>
这是在命令行上起作用的:
curl -u 'my_api_key:X'
-H 'Content-type: application/xml'
-d '<?xml version="1.0" encoding="UTF-8"?> <person><first-name>Savos</first-name><last-name>Aren</last-name><title>Archmage</title><company-name>Winterhold College</company-name><contact-data><email-addresses/><phone-numbers><phone-number><number>555-555-5555</number><location>Home</location></phone-number><phone-number><number>555-555-5555</number><location>Work</location></phone-number><phone-number><number>555-555-5555</number><location>Mobile</location></phone-number></phone-numbers><addresses><address><city>Winterhold</city><country>Tamriel</country><state>Skyrim</state><street>Hall of the Elements, College of Winterhold</street><zip>99999</zip><location>Work</location></address></addresses></contact-data></person>'
https://myuserid.highrisehq.com/people.xml
这是我的包装类:
class HighriseAPICall {
protected $_timeout = 120;
protected $_url_prefix = 'https://';
protected $_url_suffix = '.highrisehq.com';
protected $_password = 'X';
protected $_userpwd;
protected $_url;
public function __construct($api_key, $username) {
$this->_userpwd= $api_key . ':' . $this->_password;
$this->_url = $this->_url_prefix . $username . $this->_url_suffix;
}
/**
* Make the specified API call.
* @param string $action one of the four HTTP verbs supported by Highrise
* @param string $resource_name the Highrise resource to be accessed
* @param string $xml a well-formed XML string for a Highrise create, update, or delete request
*
* $xml parameter should include any query parameters as suggested by Highrise API documentation
* eg, if you want to GET all People, pass in "/people.xml"
* and if you want to get People by search term where field=value,
* then pass in "/people/search.xml?criteria[field]=value"
*/
public function makeAPICall($action,$resource_name,$xml=null) {
/* initialize curl session and set defaults for new API call */
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $this->_url . $resource_name);
curl_setopt($curl, CURLOPT_USERPWD, $this->_userpwd);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, $this->_timeout);
/* if xml was passed in, set header and postfields */
if (isset($xml)) {
curl_setopt($curl, CURLOPT_HTTPHEADER, 'Content-type: application/xml');
curl_setopt($curl, CURLOPT_POSTFIELDS, "$xml");
}
/* set action as custom request */
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $action);
/* get the string response from executing the curl session */
$result = curl_exec($curl);
curl_close($curl);
// return the response as a simpleXMLElement
try {
$result_simplexml = new SimpleXMLElement($result);
}
catch (Exception $e) {
throw new Exception("Highrise API Call Error: " . $e->getMessage() . ", Response: " . $result);
}
if (!is_object($result_simplexml)) {
throw new Exception("Highrise API Call Error: Could not parse XML, Response: " . $result);
}
return $result_simplexml;
}
}
?>
我正在使用的简单测试页:
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
</head>
<body>
<?php
require_once('HighriseAPICall.class.php');
$highrise_api_key = 'OBSCURED';
$highrise_username = 'OBSCURED';
$highrise_api = new HighriseAPICall($highrise_api_key, $highrise_username);
$person_xml ='<?xml version="1.0" encoding="UTF-8"?> <person><first-name>Savos</first-name><last-name>Aren</last-name><title>Archmage</title><company-name>Winterhold College</company-name><contact-data><email-addresses/><phone-numbers><phone-number><number>555-555-5555</number><location>Home</location></phone-number><phone-number><number>555-555-5555</number><location>Work</location></phone-number><phone-number><number>555-555-5555</number><location>Mobile</location></phone-number></phone-numbers><addresses><address><city>Winterhold</city><country>Tamriel</country><state>Skyrim</state><street>Hall of the Elements, College of Winterhold</street><zip>99999</zip><location>Work</location></address></addresses></contact-data></person>';
$response = $highrise_api->makeAPICall('POST', '/people.xml', $person_xml);
echo htmlentities($response->asXML());
?>
</body>
</html>