Getting started with the Upsites API (Optional feature)
Using this API is optional and easy! But please ignore this page if you have no programming skills. Your website maker will know what to do, please forward this page.
The upsites API is accessible for everyone with an
Upsites account. the API is located on:
http://api.upsites.com/api/api.aspx
total variable list:
| &action= |
The action you want to execute on the API. You can use 'add', 'delete' and 'details'. For example &action=add |
| &user= |
Upsites account e-mailaddress, for example: &user=sales@upsites.com |
| &password= |
Upsites account password, for example: &password=123456ab |
| &url= |
New url to add to your account, for example &url=http://www.yoursite.com |
| &email= |
The e-mailaddress you want your notification on for this url, for example &email=notify@upsites.com |
| &mobile= |
The mobilenummer you want your notification on for this url, for example &mobile=0031612345678 |
| &checkUrlID= |
When you add an url, the API will return an ID with the name checkUrlID. Use this ID to execute the action 'details' or 'delete'. |
1 of 3 Action: Add
Adding a new url to your account. As you can see this is all pretty straight forward. I will give you all the information in 1 example:
http://api.upsites.com/api/api.aspx?action=add&user=sales@upsites.com
&password=123456ab&url=http://www.yoursite.com&email=notify@upsites.com&mobile=0031612345678
The API will response: (example)
<![CDATA[<Response url='http://yoursite.com'><status>Ok</status><checkUrlID>123</checkUrlID></Response>]]>
2 of 3 Action: Details
Request uptime details for an url. Execute example:
http://api.upsites.com/api/api.aspx?action=details&user=sales@upsites.com
&password=123456ab&checkUrlID=123
Response example:
<![CDATA[<Response url='http://yoursite.com'><urlUptimeInProcent>99.4</urlUptimeInProcent><status>Warning</status></Response>]]>
3 of 3 Action: Delete
Delete an url from your account. Execute example:
http://api.upsites.com/api/api.aspx?action=delete&user=sales@upsites.com
&password=123456ab&checkUrlID=123
Response example:
<![CDATA[<Response url='http://yoursite.com'><status>Ok</status><checkUrlID>123</checkUrlID></Response>]]>
