php - 如何在对 XPLAN API 的 CURL 请求中构造 edai.Search 方法的第三个参数?
问题描述
我正在尝试在 API 上运行搜索,该 API 需要将我的查询数据设置为嵌套在 XML 请求中的 XML。我将发布我的整个类和方法调用(我将其发送给 iress 技术支持),以便对其进行全面审查,并且在任何人都无法访问相同 API 的情况下,他们可以立即为自己重现问题。
class XMLCurler
{
private $username = '[redacted]';
private $password = '[redacted]';
private $url = 'https://[redacted].xplan.iress.com.au/RPC2/';
public $ch; // the curl handle
public $token;
public $results;
public function __construct() {
if ($this->connect()) {
if ($this->login()) {
echo "<div class=\"success\">Successful Connection & Login. Token: {$this->token}</div>";
}
}
}
public function __destruct() {
if ($this->ch) {
$this->disconnect();
}
}
public function connect() {
if (!$this->ch = curl_init($this->url)) { // generate curl handle
echo "<div class=\"error\">CURL Error While Connecting (check url)";
return false;
}
return true;
}
public function disconnect() {
curl_close($this->ch);
}
public function processResponse($response) {
if (!$response) {
echo "<div class=\"error\">CURL Error While Attempting to Login - No XML token string<br><b>" , curl_error($this->ch) , "</b></div>";
return false;
}
$decoded = xmlrpc_decode($response);
if (is_array($decoded) && xmlrpc_is_fault($decoded)) {
echo "<div class=\"error\">Error Response: {$decoded['faultString']} ({$decoded['faultCode']})</div>";
return false;
}
return $decoded;
}
public function login() {
$postfields = xmlrpc_encode_request('edai.Login', array($this->username, $this->password)); // package as xml
curl_setopt($this->ch, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($this->ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 0); // not advised, I need to find out how to avoid this
curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0); // not advised, I need to find out how to avoid this
if (!$token = $this->processResponse(curl_exec($this->ch))) {
return false;
}
if (!preg_match("~^[\w+]{20}$~", $token)) {
echo "<div class=\"error\">Invalid/Unexpected Token Generated<br><b>$token</b>";
return false;
}
$this->token = $token; // cache the valid token
return true;
}
public function listChildren($path) {
$method = "edai.ListChildren";
$request = xmlrpc_encode_request($method, array($this->token, $path));
echo "<div class=\"notice\">XMLRPC Encoded Request (for $method): <pre>" , htmlentities($request) , "</pre></div>";
curl_setopt($this->ch, CURLOPT_POSTFIELDS, $request);
if (!$results = $this->processResponse(curl_exec($this->ch))) {
return false;
}
$this->results = $results; // cache the valid results
return true;
}
public function search($basepath, $queryxml) {
$method = "edai.Search";
/** Desperate/Manual xml construction ...
* $xml = new DOMDocument("1.0", "utf-8");
* $xml->appendChild($methodCall = $xml->createElement("methodCall"));
* $methodCall->appendChild($methodName = $xml->createElement("methodName"));
* $methodCall->appendChild($params = $xml->createElement("params"));
* $params->appendChild($param1 = $xml->createElement("param"));
* $param1->appendChild($value1 = $xml->createElement("value"));
* $value1->appendChild($string1 = $xml->createElement("string"));
* $params->appendChild($param2 = $xml->createElement("param"));
* $param2->appendChild($value2 = $xml->createElement("value"));
* $value2->appendChild($string2 = $xml->createElement("string"));
* $params->appendChild($param3 = $xml->createElement("param"));
* $param3->appendChild($value3 = $xml->createElement("value"));
* $value3->appendChild($string3 = $xml->createElement("string"));
* $string3->appendChild($EntitySearch = $xml->createElement("EntitySearch"));
* $EntitySearch->appendChild($SearchResult1 = $xml->createElement("SearchResult"));
* $SearchResult1->setAttribute("field", "first_name");
* $EntitySearch->appendChild($SearchResult2 = $xml->createElement("SearchResult"));
* $SearchResult2->setAttribute('field', "last_name");
* $EntitySearch->appendChild($SearchQuick = $xml->createElement("SearchQuick"));
* $SearchQuick->appendChild($s = $xml->createElement("s"));
* $xpath = new DOMXPath($xml);
* $result1 = $xpath->query("//methodName");
* $result1->item(0)->nodeValue = $method;
* $result2 = $xpath->query("//params/param[1]/value/string");
* $result2->item(0)->nodeValue = $this->token;
* $result3 = $xpath->query("//params/param[2]/value/string");
* $result3->item(0)->nodeValue = "entitymgr/client";
* $result4 = $xpath->query("//SearchQuick/s");
* $result4->item(0)->nodeValue = "last_name:Smith";
* $xml->formatOutput = true;
* $request = $xml->saveXML();
*/
/** Desperately attempted passing array ...
* $queryarray = array(
* "EntitySearch" => array(
* array(
* "SearchResult" => array(
* "@attr" => array(
* "field" => "first_name"
* )
* )
* ),
* array(
* "SearchResult" => array(
* "@attr" => array(
* "field" => "last_name"
* )
* )
* ),
* array(
* "SearchQuick" => array(
* "s" => "last_name:Smith"
* )
* )
* )
* );
*/
$request = xmlrpc_encode_request($method, array($this->token, $basepath, $queryxml)); // this mutates the nested $queryxml string
// Causes:
//Error Response: UNKNOWN(CORBA.UNKNOWN(omniORB.UNKNOWN_PythonException, CORBA.COMPLETED_MAYBE)) (-32505)
//$request = html_entity_decode($request); // repair encoded entities
//$request = preg_replace('~(?:>\K\s+)|(?:\s+(?=<))~', '', $request); // strip every whitespace character between tags (hack)
// Causes:
// Error Response: ExpatError(syntax error: line 1, column 0 (byte 0)) (-32505)
echo "<div class=\"notice\">XMLRPC Encoded Request (for $method): <pre>" , htmlentities($request) , "</pre></div>";
curl_setopt($this->ch, CURLOPT_POSTFIELDS, $request);
if (!$results = $this->processResponse(curl_exec($this->ch))) {
return false;
}
$this->results = $results; // cache the valid results
return true;
}
}
以下是我拨打电话的方式。 edai.ListChildren
工作,因为我不必发送任何 XML 数据。 edai.Search
不起作用,因为我未能在 XML 请求中正确准备 XML 查询。
$XC = new XMLCurler();
/* edai.ListChildren works as desired/expected */
$path = "/entitymgr/client";
if ($XC->listChildren($path)) {
echo "<div>List of Children Successful.<pre>";
var_export($XC->results);
echo "</pre></div>";
}
/* edai.Search does not work */
$basepath = "entitymgr/client";
$queryxml = <<<XML
<EntitySearch>
<SearchResult field="first_name"/>
<SearchResult field="last_name"/>
<SearchQuick><s>last_name:Smith</s></SearchQuick>
</EntitySearch>
XML;
if ($XC->search($basepath, $queryxml)) {
echo "<div>Search Successful.<pre>";
var_export($XC->results);
echo "</pre></div>";
}
这是尝试的请求和错误消息。
这是我提供的手册的相关部分(XPLAN XML-RPC EXTERNAL DATA ACCESS INTERFACE 7 May 2013):
几周前我联系了 iress.com,他们打电话给我,粗略地确认我被授权访问 API,并告诉我他们会保持联系 - 后续电话没有发生,我会想回到这个项目上工作。
我确实知道有一个姓氏Smith
来匹配我的查询。
我没有 Python 经验,所以错误响应对我没有帮助。我做了比我发布的更多的冰雹尝试,但我厌倦了浪费我的时间。我不知道第三个参数是否要完全嵌套在 a <value>
, <param>
, <struct>
, <string>
, <array>
,<xml>
或其他东西中。
如果有人对如何为请求准备 XML 查询有任何建议,我将运行它们并提供反馈。
我也很高兴收到关于类设计、安全问题和完全不同的 php 方法edai.Search
以返回一些有用数据的建议。
根据@ThW 的要求,这里是 xml 尝试的集合及其各自的错误响应:https ://pastebin.com/dYtwXWxz
解决方案
在黑暗中拍摄,因为我无法直接测试 API...
也许 xmlrpc_encode_request 调用可以使用命名参数:
$params = [
'context' => $this->token,
'basepath' => $basepath, // try with a leading slash, too, in spite of the docs listing it w/o one
'queryxml' => $queryxml,
];
$request = xmlrpc_encode_request($method, $params); // this mutates the nested $queryxml string
如果这不起作用,请停止乱用代码并安装SoapUI或Postman或Insomnia或类似的,并手动构建您的请求。
我怀疑您将在半小时内收到一个工作请求,并且可以从该请求向后工作以调试您的代码/重写您的代码。如果我可以访问 API,我会为你做这件事。
检查事项:
编码是否有区别(应该是 utf8 而不是 )?
XML 查询需要被视为一个字符串,因此当您的 GUI 客户端发出请求时,请确保它在 CDATA 标记中编码/包装。根据您选择的客户,它可能会为您完成,只需确保完成
推荐阅读
- javascript - 如何在 React 中为上传到数组的不正确数据触发警报消息
- android - 如何在 android webview PWA 中读取/写入本地和会话存储?
- php - Dompdf Tutor LMS“找不到图像或类型未知”
- windows - 默认 1MB 堆栈中缺少 KB
- docker - docker和runc有什么关系?
- jasmine - 从 mocha chai 迁移到 Jasmine
- javascript - 在 setData 之后,xKey 标签在 Morris.js 上消失
- javascript - 无法使用函数内的函数更新数据变量
- json - 在 jsonapi 中包含具有相同 ID 和类型的多个关系的方法
- android - Ionic - APK Build 总是生成具有旧值的旧 apk