Getting Started With The skyclerk Api
The Skyclerk API Version 1 can be accessed with a user's token. A particular user can access their token via their "My Settings" section of the Skyclerk application. A token can be reset at anytime. The advantage of using a token system is so a user does not have to give a third party their email address or password.
Skyclerk also provides a way to get a user's token via this API by posting the user's email address and password. If you are building a 3rd party application is it recommended that you have the user share their token with you directly instead of using this method. More information on this method below.
All responses with the Skyclerk API are returned in JSON format. For more information on JSON please checkout http://en.wikipedia.org/wiki/JSON
Retrieving a user's access token
Once again this is not the recommended way to get a user's access token if you are building a 3rd party application. It is recommended you have the user give you their API token directly.
Post URL: https://api.skyclerk.com/api/v1/getapikey (yes please include the "api")
Post Data: Email, Password (case sensitive)
Example Request
curl -d "Email=user@example.com&Password=yourpassword"
https://api.skyclerk.com/api/v1/getapikey
Example Response
{
"status": 1,
"accounts": [
{
"AccountsDisplayName": "Acme Inc.",
"AccountsUrl": "https://demo.skyclerk.com",
"UsersApiKey": "a61d84c0bbd7f3c3c6b3db5c0b60ee"
},
{
"AccountsDisplayName": "Cloudmanic Labs, LLC",
"AccountsUrl": "https://demo2.skyclerk.com",
"UsersApiKey": "8f7ac4344a3c53fc65fdd06be09490"
}
]
}
Upon success this request will return a list of accounts for this user. Most users will just return one account, some users have more than one account. The system will only return accounts if there is a match on email and password. If the user has different emails or passwords between accounts this request will only return accounts with the exact Email / Password match. The UsersApiKey will never change unless the user decides to change it. All requests for data must be made to the proper "AccountsUrl" so you will want to store that as well.
If the request was a success "status" will equal to "1". If the request was a failure "status" will be equal to "0" and "error" there will be an error message under the array index "error".
