ChartHop Connect provides an end-to-end workflow to let you turn on payroll APIs for your application using a simple Oauth2 flow.
If you are developing an application that relies on underlying payroll API data, you can use ChartHop Connect to connect to a single API -- the ChartHop API -- and let ChartHop handle the messy details of connecting to each particular payroll or HR system.
[Your App] ---> [ChartHop API] ---> [Payroll System]
The experience for the user, your customer, will be to click from your application and walk through a step-by-step workflow to turn on their payroll API, then redirecting it back to your application.
If they already are an Owner of a ChartHop account, they will be prompted to connect to their existing account, but if not, a free account will be created on the fly.
Requesting ChartHop Connect access
To build a ChartHop Connect app, email email@example.com with a "ChartHop Connect App Request."
Then provide the following information:
- The name of the App.
- Specific fields that you want to be authorized to retrieve (see Swagger).
- The Oauth2 Redirect URL.
- This should be a URL on your site that you control, and can receive redirect traffic to.
- Make sure to add the full URL including https://.
The support team will then set up a ChartHop Connect app and email you back your client_id for that app.
The app must also include two versions of your logo - both in PNG format:
- The Image - your ISO logo (100x100).
- This will appear with a rounded space so make sure the content fits within the circle.
- The Wordmark Image - your wordmark logo (150 x 100).
- Please ensure this has a transparent or white background.
Setting up ChartHop Connect
There are only a few steps, which should be familiar if you've integrated an Oauth2 authorization workflow before:
- From your application, create a link that connects the user to the ChartHop Connect workflow.
- This will be a URL provided by our Support team which will look like:
- When the user completes the ChartHop Connect workflow, they will be redirected to your Oauth2 Redirect URL with a parameter called code which will contain an authorization code.
- When you receive requests to that URL, exchange the code for a ChartHop API key.
- You can accomplish this by making a POST to the following URL:
- Pass the following parameters (as application/x-www-form-urlencoded):
You will receive back a response that contains an access token, in the format:
You can then use that access token to query the ChartHop API for that particular customer. For more information about querying the ChartHop API, see Syncing From ChartHop.
Setting up ChartHop Connect button
To use the Charthop Connect Button you must have a Client ID. The button will redirect the users to the charthop connect module with the partner's client parameters.
To get the Charthop Connect Button to appear on your web app simply copy and paste this snippet on your <head> element.
and you will be able to place the button by copying the following line on the place of your choice to be rendered.
(where client_id is the partner client id provided from ChartHop)
By default the Button will appear with this appearance:
You can change the color and size option by including these arguments into your element like this:
with any of the following available combinations:
Here is the complete list of available options:
Client ID (Required)
The Partner Client-Id to be included on the redirect URL
HR System Param
The HR System name param, to skip the HR system selection step
• adp • bamboo • gusto • humaans • justworks • namely • paylocity • rippling • sapling • sequoia-one •successfactors • trinet • ultipro • workday • zenefits
Defines the size of the button and whether or not to include the ChartHop Isotype
• short (default) large
Button Color Style
Defines the color variant
•default (default) • blue • dark • light large
The browser behavior once the button is clicked
• blank (default) • parent • self • top