Public APIs

Modified on Thu, 28 Aug at 3:44 PM

Public APIs is a free feature that allows you to integrate occy’s recruitment software into your existing systems. With Public APIs, you can easily create, access, and manage API keys, enabling a connection between occy's recruitment solutions and your applications. Whether that’s sending your jobs with a company careers page not created in occy or allowing recruiters to securely access candidate information, we have a range of endpoints to suit your needs.

As well as allowing you to manage and edit your API Keys, occy further streamlines the process by allowing your development team to access the endpoints page without creating an account or compromising on security.

Learn more in the demo and article below.

What is an API Key and What Makes it Secure?

A public API key is a unique identifier that is provided to developers to access certain functionalities or resources offered by an API (Application Programming Interface). This key is used as part of the authentication process when making requests to the API. This means your development team are able to use the key to create a secure link between occy and your existing systems.

Access or integration with occy is only possible with the API key. Bearer authentication is required to access the Occy API endpoints. Users must include an authorization header with a valid access token in their requests to ensure secure access to our APIs.

How Do I Set Up an API Key?

Start by navigating to the API Hub screen by clicking Settings in the main menu, then API Hub. Here you will see two options; View API Endpoints and Manage API Keys.

Click on View API Endpoints to see the available endpoints. The URL of this page can be shared with your development team for review.

Click on Manage API Keys to create and manage your API keys. If creating your first API Key, click Create API Key and then Create.

If you already have an API Key listed, you will see the screen below. Click Create API Key to add more.

Type in a label for the key. This label is for you to differentiate between multiple keys in case you need them. Then click Create.

You will then be directed back to your API Key list. Here, you'll be able to view all API Key details, including the label, unique alphanumeric code, creation date, and last accessed date. Our platform also provides options to view, copy, or delete your API key using the options in the Actions column.

Please Note: Once an API key is deleted, it cannot be recovered or restored.

Using An Integration to Advertise Roles

If you are using an API to integrate occy with a careers page, you will need to select the Company Website channel when choosing where you would like to post your advert. This will appear in the list of options along with the other channels (such as Occy Free, Premium, and Lite) before posting each campaign.