View • Attachments (0) • Info
smugmug.login.withPassword (1.2.0)
smugmug.login.withPassword
Establishes a session and logs a user in based on the specified email address (or nickname) and password.
 | Note: For security reasons, this method should only be sent over SSL |
Arguments
- string APIKey - Your API Key. More details here.
- string EmailAddress
- string Password
Result
- struct Login
- string PasswordHash
- string AccountType
- string FileSizeLimit
- struct Session
- string id
- struct User
- integer id
- string NickName
- string DisplayName
Fault Codes
- 1 - "invalid login"
- 5 - "system error"
- 11 - "ancient version"
- 18 - "invalid API key"
Sample Responses
REST
<rsp stat="ok"> <method>smugmug.login.withPassword</method> <Login PasswordHash="$1$SzcXhAg5$ryhs7e5YPJjHPN2k4es3Y1" AccountType="Pro"> <Session id="f920524b60bdb9ec711bcdbb6efd3faa"/> <User id="512" NickName="frednerk" DisplayName="Fred Nerk"/> </Login> </rsp>
JSON
{
"stat":"ok",
"method":"smugmug.login.withPassword",
"Login":{
"PasswordHash":"$1$SzcXhAg5$ryhs7e5YPJjHPN2k4es3Y1",
"AccountType":"Pro",
"Session":{"id":"f920524b60bdb9ec711bcdbb6efd3faa"},
"User":{"id":512, "NickName":"frednerk" "DisplayName":"Fred Nerk"}
}
}
PHP
a:3:{
s:4:"stat";
s:2:"ok";
s:6:"method";
s:26:"smugmug.login.withPassword";
s:5:"Login";a:4:{
s:12:"PasswordHash";s:34:"$1$SzcXhAg5$ryhs7e5YPJjHPN2k4es3Y1";
s:11:"AccountType";s:3:"Pro";
s:7:"Session";a:1:{s:2:"id";s:32:"f920524b60bdb9ec711bcdbb6efd3faa";}
s:4:"User";a:3:{
s:2:"id";i:512;s:8:"NickName";s:8:"frednerk";s:11:"DisplayName";s:9"Fred Nerk";
}
}
}
XML-RPC
<struct> <member> <name>Session</name> <value> <struct> <member> <name>id</name> <value><string>f920524b60bdb9ec711bcdbb6efd3faa</string></value> </member> </struct> </value> </member> <member> <name>AccountType</name> <value><string>Pro</string></value> </member> <member> <name>PasswordHash</name> <value><string>$1$SzcXhAg5$ryhs7e5YPJjHPN2k4es3Y1</string></value> </member> <member> <name>User</name> <value> <struct> <member> <name>id</name> <value><int>512</int></value> </member> <member> <name>NickName</name> <value><string>frednerk</string></value> </member> <member> <name>DisplayName</name> <value><string>Fred Nerk</string></value> </member> </struct> </value> </member> </struct>
Code Samples
PHP using REST
<?php
$base = "https://api.smugmug/hack/rest/1.2.1";
$url = $base . "?";
$params = array (
"method" => "smugmug.login.withPassword",
"EmailAddress" => "YourSmugMugNickNameOrEmailAddress",
"Password" => "YourSmugMugPassword",
"APIKey" => "YourSmugMugAPIKey"
);
foreach ($params as $key => $value) {
$url .= "$key=" . urlencode($value) . "&";
}
$xml = file_get_contents($url);
?>
PERL using JSON
use LWP;
use JSON;
my $base = "https://api.smugmug/hack/json/1.2.1";
my $url = $base . "?";
my $params = {
"method" => "smugmug.login.withPassword",
"EmailAddress" => "YourSmugMugNickNameOrEmailAddress",
"Password" => "YourSmugMugPassword",
"APIKey" => "YourSmugMugAPIKey"
};
for my $key (keys %params ) {
$url .= "$key=" . ${params}{$key} . "&";
}
my $ua = LWP::UserAgent->new();
my $response = $ua->get($url);
my $json = new JSON(unmapping =>1);
my $hash = $json->jsonToObj($response->content);
