Setup
Before we can get started with development, there’s a bit of setup to do. Please follow the steps below carefully so that you won’t have any issues down the line.
Log into the dashboard
Log into the Kombo dashboard. You should have received an invite via email but if you didn’t, reach out to your team members or to Kombo directly via Slack/Teams
Integration configuration
Go to the tools overview and select / deselect all integrations that you want to offer. You can change this at any time.
Scope configuration
Go to the scopes overview and click on “New config” or “Edit” an existing one.
Select the data models that you need and click on “Save changes”.
🦉 These scopes are just for development. To understand more about this feature and how to use it to evoke a great first impression with customers, read more here.
Set up a linked account for development
To call the API you always need to have a linked ATS account to pull and push data from. You can either get yourself a sandbox via a free trial, or use our built-in mock integration to get started faster (recommended).
Go to the integrations tab and click on “Create a sandbox integration”.
Click “Continue” and “Set up integration”.
Click on the tile that just appeared to get to the details page of the integration.
On this page, you can find all info related to the integration. For now, we will only need the integration ID though.
Create Kombo API key
Go to the Secrets tab and click on “New API key”.
Name the API key and click “Create API key”.
Copy the token and store it somewhere safe.
Test your setup
🎉 You made it through the setup and have everything in place to get started developing 🎉
To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the “get integration details”-endpoint
curl --request GET \
--url https://api.kombo.dev/v1/integrations/{integration_id} \
--header 'Authorization: <api_key>'
You can also use any other endpoint like “get jobs” or “create application”. The Sandbox integration will return you some sample data for it.
Optional: set up Postman collection
To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:
-
Copy the link of our OpenAPI schema:
https://api.kombo.dev/openapi.json -
Open Postman, and click Import
-
Paste the URL and click Import