如何取得API
认证一个使用者session
使用者需要与一个有效、认证的session连结,才能呼叫API。login() 功能可以认证用户并生成session的token(通行证)。接下来的每个API呼叫都需要用到这个token。
Token (通行证)
token能够辨识认证的使用者,让使用者不需要在每次呼叫API时都必须再次提供登入密码。使用者可以利用getToken方法取得所有有效token的列表。使用者可以储存token,以备之后查询使用。
范例
此范例由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);
// Print the token
echo "Your Token is :" . $token;
} catch (XML_RPC2_FaultException $e){
echo "ERROR:" . $e->getFaultString() ."(" . $e->getFaultCode(). ")";
}
?>