API

OneBody provides a basic API for many operations, especially remote updating of people and family data.

Authentication

Every call to the API requires http basic authentication:

• Username is the email address of a user with super admin privileges.
• Password is their API key

You can specify basic auth with cURL with the switch -u, like so:

curl -u admin@example.com:APIKEYHERE ...

To retrieve your API key, run the following rake task from your OneBody instance:

rake onebody:api:key EMAIL=admin@example.com

If you have multi-site enabled, you must specify the site name, like this:

rake onebody:api:key EMAIL=admin@example.com SITE="Site Name"

Methods

• HashifyPeople
• HashifyFamilies
• BatchPeople
• BatchFamilies?