Sunday, March 11, 2012

My answer to "How can i use the api??"

This is my answer to a Question on Support site for LampCMS project


More about the API
There is a page that allows a developer to register their app and to get an API key.
Some api methods require an api key and you as admin can also set a daily limit of api requests, this limit is per app. Also admin may be able to disable an access to the api based on the api key.

You can provide a link to register the APP at the /viewapps/ url
If user does not have any apps registered, they are redirected to a page to create their first app.

You can try it here:
http://support.lampcms.com/viewapps/

Once a client has a unique API key, they should add it to api call, like this:
&apikey=theirkey

For POST methods a client must pass apikey as a post parameter

API also supports basic authentication where username and password of actual site user maybe passed in headers - this is based on the HTTP basic authentication RFC.

You are strongly advised to use https ONLY for such requests as username and password will be send over the network in clear text.

No comments:

Post a Comment