Method: setup
Description:
Setup a shared account with analysis and subscription (1 month recurring).
Requires:
API key, url, email, password, period
Available in:
Version 1.0
Parameters:
apikey: The API key that is provided with your reseller account.
url: The URL of the website that you want to analyze. This can be the host name (http://www.hostname.com) or a page that can be used as a starting point for the analysis (http://www.hostname.com/welcome.html).
email: Lipperhey can share an analyses with other user after a subscription is bought. By giving an email address (email=name@domain.com) and a password (password=c533ada01519f35e2b32ff13c88d6a08dff6d61c). Lipperhey will create or update an account and share the analyses.
password: The password is only needed if an email address was given. The password must be encrypted with SHA1.
period: When seting up a shared account you must submit a subscription period. Lipperhey offers 4 possible subscription periods: 0 (trial), 1, 6 or 12 months. The selected period will always be billed up front. After the selected period you will be billed monthly for the lower monthlee fee. Depending on your reseller account the we will always start with a 3-day trial period in which you will not be billed. If you cancel your subscription during this trial period you will not recieve a bill.
An example to setup a shared account with an new analysis and a subscription looks like this:
Response:
If there are no errors, the API will respond with the the ID of the new analysis and the login key of the user. With this key you can redirect the user to directly to his Lipperhey account. The user doesn't have to login, the key will be validated by Lipperhey and the user will be logged in automatically.
The url points to the login page and contains the key with slashes ../login/key/
http://www.lipperhey.com/en/login/19c1aa546fd706753s949b383be245d149c1eb17/
<!--Lipperhey API Response-->
<response queries="6" time="15 ms" calls-left="9985">
<error/>
<websites offset="0" results="1">
<website domain="lipperhey.com" timestamp="2009-07-07 10:54:21">
<id>1653860</id>
<key>19c1aa546fd706753s949b383be245d149c1eb17</key>
</website>
</websites>
<users/>
</response>
If an error occured a description of the error wil be available in the error field.
Examples: