Table of Contents
- Fetching your Personal Access Token
- Available APIs
- API Console
We have a set of APIs that are designed to enable automation of repetitive tasks such as test administration and fetching results. Companies use our API to generate dashboards or integrate with their bespoke HR systems. Note that we have pre-built integrations with some of the popular Applicant Tracking Systems. If you already use one of them you may not have a need to use our API directly. Find out more about our existing ATS integrations here.
Fetching your Personal Access Token
To get started with using our API you will need an access token. Every Enterprise user with a HackerRank for Work account has unique personal access token available in their account settings, which can be used to access the API. The following screenshot shows how to find an access token in your account:
You can revoke any of your personal access tokens and generate additional ones at will. There is no limit on the number of personal access tokens you can generate.
The following table lists the different APIs we have and what you can do with them. Most of our customers use the Tests and CodePair APIs. The others in the list are for niche use cases and at this time they are used mostly by our own internal teams.
|Sl.No||API Name||Link to Technical Documentation||Notes on Use Cases|
|1||Tests API||https://www.hackerrank.com/work/apidocs||Most popular with our existing customers. The calls in this API allow you to perform repetitive tasks pertaining to the Tests module - like invite candidates for a test, fetch candidate status, including detailed reports, view details about tests and the contained questions, etc.|
|2||CodePair API||Link here||Allow such actions to create a new QuickPad, or schedule an interview, view all interviews, fetch reports etc.|
|3||Codechecker API||http://apidocs.hackerrank.com/checker||The endpoints in this API allow users to compile code written in any of our 50+ supported languages. This is generally not used by any of our HackerRank for Work customers.|
|4||Brahma API||http://apidocs.hackerrank.com/brahma||Brahma is the name of a service that allows code stubs to be generated during the problem setting phase. This is generally not used by any of our HackerRank for Work customers.|
If you are a developer curious to try out our API, you should go to the Console for the respective API. The links are given in the table above. The console also has basic information on the required parameters and other such documentation. See the other pages here for some additional documentation that we could not fit on the API console.