Information Technology Reference
In-Depth Information
in the next section, we'll explore object operations. i am not going to list all of
the constants or fault codes, but you can look those up in the reference manual.
API Calls
You initialize and create an Api session using the login call. the Url (which includes
a session id returned by the login call) should be reused during subsequent calls until
the session expires. the session should always be closed using the logout call.
login
the soAp login call must be made to the following Url:
https://ondemand.indextools.com/IndexTools/services/IndexToolsApiV3
succeeding calls are made to the Url returned by the login call. keep in mind
that this Url will change once the Api is fully out in the open.
the login call takes an Api partner id and password as well as an optional user
id and password, and then validates them. note that the Api partner id and password
are different from the Yahoo! Web Analytics consultant partner id and password in
the user interface.
there are two types of login privileges. if only the partner id and password are
supplied, a partner session will be created and only the
createAccount
operation will be
allowed. if both the partner and user login information are supplied, a user session will
be created with almost nonrestricted privileges.
table A.3 lists the fields included in a login request. Fields marked by an asterisk (*)
in the description are mandatory (this applies to all object tables in this appendix).
table A.4 lists the returned output fields after a login request has been made.
352
P
Table A.3
Fields for Login Calls
Name
Format
Description
partner_id
String
API partner identifier supplied by Yahoo! (*)
partner_password
Maximum of
32 characters
API partner password supplied by Yahoo! (*)
user_id
Maximum of
32 characters
Account's administrative user ID. If the
user_id
and
user_password
parameters are not supplied, the session
will have limited privileges and only the
createAccount
operation will be allowed.
Maximum of
32 characters
If the
user_id
and
user_password
parameters are not
supplied, the session will have limited privileges and only the
createAccount
operation will be allowed.
user_password
Boolean
Specifies whether the login response should return a secure
URL in the
server_url
parameter. This is an obsolete
parameter, as all responses will be sent to secure URLs. This
parameter must be set to
true
at all times. (*)
secure
