To use this guide, log in to Ceipal ATS

Obtaining your API Key

1. Click on your profile in the upper right section of Ceipal.
2. Click "Admin Setup"

3. Hover "API Settings"

4. Click "API Access Configuration"

5. Click the "Copy" Icon next to "Your API Key" and save the value

Setting up ability to create applicants

You should already be in the API Settings section after the previous step.

1. Click on "Custom API Configuration"
2. Click on "Add"

3. Give the API a name

4. Select "Applicants" in the dropdown

5. Select the "POST(Push to Ceipal)" method

6. Ensure "Send all fields" is ticked

7. Click "Save"

8. Copy the value for "API Full URL"

Providing access to your Ceipal Instance

1. Enter the email and password you use to log in to Ceipal. If you have configured a separate API-only password in the API Access Configuration settings, use that password instead.

2. Enter the API key you obtained in the Admin portal of Ceipal

3. Enter the custom API Url you generated in the Admin Portal

Your Ceipal instance will now be connected and start syncing data.