API keys allow you to connect your system to external platforms securely and reliably. This article explains what an API key is, how to request one from the Support Team, what a Callback URL is, and which integration partners are currently supported.
⚠️ Important: API keys are only issued to partners with a formal agreement with Vincere. If your chosen partner is not on the approved list, an API key cannot be created for them.
Understanding and Requesting API Keys
What Is an API Key?
An API key is a unique identifier used to authenticate a user, developer, or application when communicating with an API. In Vincere, API keys enable secure data exchange between Vincere and other software or services.
API keys are important for three key reasons:
Integration — They allow seamless connections with other platforms and tools.
Security — They ensure only authorised users and applications can access Vincere data.
Automation — They enable task and workflow automation, improving efficiency.
How to Request an API Key
Before submitting a request, check the list of approved integration partners below. If your partner does not have an existing agreement with Vincere, an API key cannot be issued for them.
If your partner is on the approved list, gather the following information before contacting Support:
Your tenant URL.
The name of the integration.
The callback URL.
Once you have these details ready, contact the Vincere Support Team to proceed.
📌 Note: If your third-party contact is interested in becoming a Vincere integration partner, reach out to the Vincere Support Team and they will forward the contact details to the Partnership Manager to explore integration further.
What Is a Callback URL?
A Callback URL — also known as a redirect URL — is a stable HTTPS endpoint provided by your vendor or developer. It is required to start the API key approval process.
After authentication, Auth0 redirects to this URL and passes additional parameters, including an authorisation code that is exchanged for tokens (id_token, access_token, and refresh_token). This process enables secure token refresh and error handling, making the Callback URL essential for stable API integrations.
Security Requirements for Callback URLs
⚠️ Important: Always use a reachable HTTPS URL as your Callback URL. Do not use localhost (for example, 127.0.0.1), as this will prevent proper authentication.
Add your application's URL to the client's Allowed Callback URLs in Auth0. If this step is skipped, authentication may fail.
If you need separate Callback URLs for different environments (for example, development, staging, or production), you can request separate API credentials for each, or add additional URLs to the existing credentials. The same API key works across all configured URLs.
If your Callback URL becomes outdated, you cannot change the existing one, but you can add a new URL to your credentials.
List of Approved Integration Partners
|
40. Recii. 41. Referoo. 42. Ringover. 43. RoboRecruiter. 44. RSign. 45. Scout. 46. Shazamme. 47. SourceBreaker. 48. SourceWhale. 49. StaffUpApp. 50. Stitch. 51. The Comms Guys. 52. The Scoop. 54. Wave. 55. Woo. 58. referoo. |
📌 Note: If the partner you want to integrate with is not listed above, Vincere cannot create API credentials for them. For example, Lovable is not currently a Vincere integration partner, so an API key for Lovable cannot be provided.
How to Access the Vincere API Documentation
You can access the full Vincere API integration documentation to explore available endpoints and setup guidance. This is especially useful for IT specialists and developers setting up non-partnered integrations independently.
If you have questions about the API documentation or would like a training session, contact the Vincere Support Team to request one. The Partnership Manager will follow up with a quote.
📌 Note: The Vincere Customer Support team does not handle technical customisations. For complex or custom API setups, we strongly recommend working with an experienced IT specialist with relevant API knowledge.
🤔 FAQs
Q1: Can I use a staging domain as my Callback URL initially?
Answer: Yes, you can use a staging domain and add your production domain later. Both URLs can coexist within the same API credentials.
Q2: Is a Callback URL required for all integrations?
Answer: Yes, a Callback URL is mandatory for generating API keys and completing the authentication flow.
Q3: What should I do if my Callback URL is outdated?
Answer: You cannot edit an existing Callback URL, but you can add a new one to your credentials. Once added, reauthenticate using the updated configuration.
Q4: What if my preferred integration partner is not on the approved list?
Answer: If your third-party contact is interested in partnering with Vincere, contact the Vincere Support Team. They will pass the details to the Partnership Manager to explore the possibility of a formal integration agreement.