Vincere

Setup

For Cyclr to connect with the Vincere API you will need to select a suitable user account within Vincere. This account will require some setup as described below.

We have experienced issues when using the Safari web browser to sign in to Vincere so would recommend using another browser.

1. Login to the Vincere Application using the account specific URL, e.g. https://{{yourdomain}}.vincere.io/loginForm.do

2. Select Settings > Marketplace

3. Select the API Tab

4. Click "Create new token" button, this will display the API Key

5. Click "Create new Client ID" button, this will display the Client ID

6. Enter the callback URL using your Cyclr Partner's Service Domain into the "Callback URL" field, e.g.
   https://{{Your Cyclr service domain e.g. http://app-h.cyclr.com }}/connector/callback.
   Your Service Domain can be found in your Cyclr Partner Console under Settings > General Settings > Service Domain.

Connector Setup

The Connector now can be installed using the credentials obtained in the above steps:

Client ID: Vincere Client ID

Secret: Leave this blank

Domain: yourdomain (see your URL when accessing Vincere, https://{{yourdomain}}.vincere.io

API Key: Vincere API Key

Use Custom Fields

When you use custom fields, the Field Location mapping varies based on the custom field type.

For example, to use Candidate custom fields:

1. Run the Get Candidate Custom Fields method to list the available custom fields.

2. Make note of the Key and Type fields in the response

If you want to add a custom field to Get Candidate, the table below shows the Field Location you need to use depending on the field type.

When you use List methods, such as List New Candidate Records, make sure to include the correct parent array. For example [items].

For more information, see the Cyclr documentation on how to add custom fields to a method.