API/RaaS Integrations with Quantum Workplace

In this article:

• Overview
• Build Process
• Credentials

Overview

With an API/RaaS (‘Reports-as-a-Service’) integration, your organization creates a report within your HRIS and provides QW with credentials to access this report. It will be pulled and processed nightly.

We currently offer API/RaaS integrations with the following systems:

• BambooHR
• Namely
• Ultipro/UKG
• Workday

Build process

1. Your organization creates the file/report with the data you want the integration to process.
   1. See this page for information about file/report dos/donts.
2. Your organization creates the relevant user/credentials needed for QW to pull the report, and sends this info to QW. See below section for details about what we need for each type of integration.
3. QW will pull a report, validate it, and begin the build process.
4. Once QW begins the build, the timeline is up to 5 business days. When complete, the integration will be enabled and begin running nightly. You will be notified once this happens.
5. Your organization will set an integration notification admin to be notified of any processing issues.

Credentials

Bamboo

• "domain":  "xxxxxx"
  • Typically the company name (ex; 'quantumworkplace')
• "reportId":  "1234"
  • Typically a 4-digit number
• "apiUser":  "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  • Long string of numbers and letters

Namely

• "domain":  "xxxxxx"
  • Typically the company name (ex; 'quantumworkplace')
• "reportId":  "XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
  • String of numbers and letters with hyphens throughout
• "apiKey":  "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  • Long string of numbers and letters

Ultipro/UKG

• "userName":  "XXXXXXX"
• "password":  "XXXXXXXX"
• "userAccessKey":  "ABCDEF000010"
  • API Key – typically some letters followed by some numbers with a lot of zeroes
• "clientAccessKey":  "X1X2X"
  • API password – short string of letters/numbers
• "reportPath":  "/content/folder[@name=\'zzzCompany Folders\']/folder[@name=\'Vandelay Industries\']/folder[@name=\'Service Account Reports - Vendor\']/report[@name=\'Quantum Workplace - HRIS Integration Data File\']"
  • Path to the report. Typically begins with /content/folder/
• "reportName":  "Quantum Workplace – HRIS Integration Data File"
  • Custom report name
• "biDataServiceUrl":  https://service2.ultipro.com/services/BIDataService
  • Link which looks very similar to this sample

Workday

• "url":  https://services1.myworkday.com/ccx/service/customreport/companyname/reportfolder/reportname?format=csv
  • URL to the report
• "apiUser":  "XXXXXXXXXXX"
  • API username
• "apiPassword":  "XXXXXXXXXX"
  • API password