GetAuthToken
This function takes an Authentication Object and returns an Authentication Token. You call this function to “login” to the API and gain access to the data available to a specific user account.
The returned Authentication Token is a string. It is not intended that you will parse it or otherwise analyze it; you simply pass it to all of the other API functions. This token has a limited lifetime of 20 minutes. You may use it as many times as you like within that period, but once it expires, the other functions of the API will return an “InvalidAuthToken” result.
The object that you pass to this function, an Authentication Object holds two strings: the user name and the password. These are the same username and password that you use to log into the EmailReach web site.
In C#, the function and its argument are declared as follows:
String GetAuthToken(AuthenticationObject authObject)
struct AuthenticationObject
{
string username;
string password;
}
The WSDL declaration is:
<s:element name="GetAuthToken">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="authObject" type="tns:AuthenticationObject" />
</s:sequence>
</s:complexType>
</s:element>
<s:complexType name="AuthenticationObject">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="username" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="password" type="s:string" />
</s:sequence>
</s:complexType>
<s:element name="GetAuthTokenResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAuthTokenResult" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
|