An open API service indexing awesome lists of open source software.

https://github.com/thinkhr-code/developer-hub


https://github.com/thinkhr-code/developer-hub

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# Welcome to the ThinkHR Developer's Hub

This github repository contains everything you need to get started using the ThinkHR platform APIs.

1. [Postman](#postman)
2. [Sample Code](#sample-code)
1. [Excel](#sample-code-excel)
2. [OAuth 2.0](#sample-code-oauth)
3. [OpenId Connect](#sample-code-oidc)
4. [SSO](#sample-code-SSO)

## Postman

* ThinkHR APIs.postman_collection.json - examples for every published ThinkHR platform API.
* Sandbox.postman_environment.json - environment definition for our developer's sandbox.
* Production.postman_environment.json - environment definition for production, use with care.
* ThinkHR_Company_Bulk_Sample.csv - Sample text file for use with the /companies/bulk endpoint.
* ThinkHR_User_Bulk_Sample.csv - Sample text file for use with the /user/bulk endpoint.


## Sample Code

Our sample code comes in the following varieties (not all samples have all varieties):

* Command Line via curl
* Excel / VBA
* Java
* Javascript
* PERL
* PHP


### Excel

Sample showing how to invoke the ThinkHR APIs from Excel.

#### ThinkHR-DataLoadViaPowerQuery.xlsx

This spreadsheet uses Excel's Power Query functionality to download from the ThinkHR platform the first hundred companies, users and configurations associated with the access token provided. Before executing these queries you will need to generate an access token using your Client Id, Client Secret, ThinkHR username and password.

#### DataLoadViaVBA.xlsm

This spreadsheet (Password: ThinkHR) uses VBA to download from the ThinkHR platform all companies, users and configurations associated with the provided account credentials. You will need your Client Id, Client Secret, ThinkHR username and password.

Use the Settings button to enter your credentials, or just click the Download button and you'll be prompted for them. Credentials are hidden from view, but the password of the spreadsheet should be changed for your own security.


### OAuth 2.0

Samples showing how to authenticate using the OAuth 2.0 password flow. The token returned here is used in the authorization header for subsequent API calls.


### OpenId Connect

Samples showing how to use OpenId Connect to provide embedded information via ThinkHR Platform APIs or for Single Sign-on to the ThinkHR Web Application.


### Single Sign-On (SSO)

ThinkHR's proprietary SSO solution utilizes an access token encoded from an Authentication Code, a username and optionally a destination. This token can be generated on the client side using Javascript, or on the server side using your language of choice. We've provided samples of both versions to get your started.