Authenticate with BambooHR

You can authenticate with BambooHR to create your own instance of the BambooHR element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the BambooHR platform.

Authenticate Through the UI

Use the UI to authenticate with BambooHR and create an element instance. You will need your API key and BambooHR Domain that you identified in API Provider Setup.

If you are configuring events, see the Events section.

To authenticate an element instance:

1. Sign in to Cloud Elements, and then search for BambooHR in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. In API Key and Company Name enter the API key and BambooHR Domain that you identified in API Provider Setup.
5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
6. Click Create Instance.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Send a request to our /instances endpoint to authenticate an element instance. When finished note the token and id.

To authenticate an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "bamboohr"
     },
     "configuration": {
       "username": "<BambooHR API key>",
       "company.name": "<BambooHR BambooHR Domain>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "bamboohr"
  },
  "configuration": {
    "username": "xxxxxxxxxxxxxxxxxx",
    "company.name": "Acme"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id":12345,
  "name":"API Instance",
  "createdDate":"2018-05-25T15:56:22Z",
  "token":"ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
  "element":{
    "id":6315,
    "name":"Bamboo HR",
    "hookName":"BambooHR",
    "key":"bamboohr",
    "description":"The API can be used to manipulate employee data and to generate reports in several formats.",
    "image":"elements/custom-element-default-logo.png",
    "active":false,
    "deleted":false,
    "typeOauth":false,
    "trialAccount":false,
    "resources":[  ],
    "transformationsEnabled":true,
    "bulkDownloadEnabled":true,
    "bulkUploadEnabled":true,
    "cloneable":true,
    "extendable":true,
    "beta":false,
    "authentication":{
      "type":"basic"
    },
    "extended":false,
    "useModelsForMetadata":true,
    "hub":"humancapital",
    "protocolType":"http",
    "parameters":[  ],
    "private":false
  },
  "elementId":6315,
  "tags":[
    "Docs"
  ],
  "provisionInteractions":[

  ],
  "valid":true,
  "disabled":false,
  "maxCacheSize":0,
  "cacheTimeToLive":0,
  "configuration":{  },
  "eventsEnabled":false,
  "traceLoggingEnabled":false,
  "cachingEnabled":false,
  "externalAuthentication":"none",
  "user":{
    "id":123456,
    "emailAddress":"claude.elements@cloud-elements.com",
    "firstName":"Claude",
    "lastName":"Elements"
  }
}