CiviCRM Rest API

Relevant Links for version 4.2

• ​Devlopers Guide API Reference
• ​API Reference
• ​Rest Interface
• ​Setting up a Site Key - necessary for Rest API.
• ​Test Server API Explorer
• ​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

Create a Site Key

1. Go to ​The Bit Mill
2. Select Uppercase, Lowercase, Numbers, Punctuation
3. Set Removals from selection as &=+$?%,/:{}#|'
4. Set length to be 32
5. Edit the CiviCRM Settings file.
   • For the test server this is: uhlbriccsapp04:/var/local/civicrm/drupal/sites/default/civicrm.settings.php

Using the REST API

An example: ​http://lcbru.xuhl-tr.nhs.uk/civicrm/ajax/rest?fnName=civicrm/contact/get&json=1&key={SITE_KEY}&name={USERNAME}&pass={PASSWORD}