如何取得API
Filter (过滤器)
如果你想检索符合某些规则的纪录,你可以使用filter。Filter会比对设定值和须定义的字段,让API方法中的filter去求回报纪录的数值。若filter被设为空白,回报的会是所有结果。
Paging (分页)
实时电子存取和显示的结果会被分列在虚拟页面上。每个页面所显示的纪录数量是由pageSize参数界定,pageNumber 参数则用来界定回报纪录的起始位置。pageNumer 从1开始。举例而言,若某特定函数回报1500笔纪录,而 pageSize 设定为100,那么就会有15页可浏览的纪录。若要检索从位置1000开始的纪录,pageNumer 必须设为10。
Sorting (分类)
你可以设定 orderBy 参数来界定检索结果的排列顺序。这个参数会照给定的字段分类结果。参数值会随函数的不同而有所变动。在系统默认值中,结果是由低而高排序。你可以使用 sortOrder 参数更改设定。若你将值设定为”desc”,结果就会由高而低排列。
范例
此范例由PHP语言写成,并需要安装PEAR XML-RPC。
<?php
/**
*
* 此范例展示如何认证使用XML-PRC的使用者
* 请注意,我们使用PEAR的XML-RPC,建议你也这么做。
*/
require_once 'XML/RPC2/Client.php';
// Account Settings
$USERNAME = 'myusername';
$PASSWORD = 'mypassword';
$API_URL = 'http://api.benchmarkemail.com/1.0';
try
{
// Create the XML RPC Object
$client = XML_RPC2_Client::create($API_URL);
// Authenticate the user
$TOKEN = $client->login($USERNAME, $PASSWORD);
// Fetch the first 10 Emails where the name contains "April" sorted on the last modified date,
// recent ones appearing first
$RECORDS = $client->emailGet($TOKEN, "April", 1, 10, "date", "1");
print_r($RECORDS);
// Fetch the next 10 Emails
$RECORDS = $client->emailGet($TOKEN, "April", 2, 10, "date", "1");
print_r($RECORDS);
} catch (XML_RPC2_FaultException $e){
echo "ERROR:" . $e->getFaultString() ."(" . $e->getFaultCode(). ")";
}
?>