= CiviCRM Rest API

== Relevant Links for version 4.2

* [[http://book.civicrm.org/developer/current/techniques/api/|Devlopers Guide API Reference]]
* [[http://wiki.civicrm.org/confluence/display/CRMDOC42/API+Reference|API Reference]]
* [[http://wiki.civicrm.org/confluence/display/CRMDOC42/REST+interface|Rest Interface]]
* [[http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=86213627|Setting up a Site Key]] - necessary for Rest API.
* [[http://lcbru-test.xuhl-tr.nhs.uk/civicrm/ajax/doc/api#explorer|Test Server API Explorer]]
* [[http://lcbru-test.xuhl-tr.nhs.uk/civicrm/api/doc|Parameter list for Test Server]] - What parameters are available for each entity in the API.

== Steps to Enable the Rest API

1. Create a site key
2. Create a user
3. Enable the user to access the REST api

== Using the REST API

1. Login using the URL: !https://{CIVIPATH}/civicrm/extern/rest.php?q=civicrm/login&name={USERNAME}&pass={PASSWORD}&key={SITE_KEY}&json=1
2. Extract the {{{SESSION_ID}}} from the response.
3. Make a request supplying the {{{SITE_KEY}}} and {{{SESSION_ID}}}