Get started

🚀 Get Started with Vincere Developer Portal
Welcome to the Vincere Developer Portal! This guide walks you through the steps to register, explore available APIs, subscribe to a plan, and finally retrieve your API key.

🔑 Step 1: Register an Account

Click on Sign Up (at the top-right corner).

Fill in your details:

• Full Name
• Email Address
• Password
• Invite code - Vincere will provide this code if you are part of an organization for which we have developed a dedicated API product
• Access type - indicate your integration type: machine to machine (m2m), end user app (end-user-app)
• Visibility
  • (Public) if the API product is public to everyone
  • (Private) if the API product is dedicated to your organization
• Organization:
  • If you are a Vincere partner, please input your organization name (e.g. Elay, HireAra, Wave, ...)
  • If you are a Vincere customer, please input your full tenant name (e.g. abc.vincere.io, ...)
• App name - Name of your application that will be integrated with our API (e.g. web-app, mobile-app, ...)

After submitting the form, your account may require activation by a Vincere admin. Please allow some time for this process.

Important: The Organization and App Name must exactly match the consent information registered by the tenant in Vincere. If there’s a mismatch, you will receive an “Insufficient Permission” error when making API requests, even if you have a valid API key.

🔐 Step 2: Log In
Return to the Vincere Developer Portal.
Click Login and enter your registered email and password.
After logging in, you'll be redirected to your developer dashboard.

📚 Step 3: Explore Available APIs
On the dashboard or homepage, navigate to the API Catalogue.

Browse through the available APIs.

Click on any API to view its:

1. Overview - Available plans and its details
2. API specifications

📦 Step 4: Subscribe to an API Plan

1. Navigate to the "Overview" tab
2. Choose the plan that you want and click "Access to this plan"
3. The product will be added to the cart. Click "Go to cart"
4. Scroll down to the section "Select an App" and:
   - If you don't have one, then click on the "Create a new app" radio button and complete the form. Please refer to the App name section below to know the naming format.
   - If you just want an additional key for a same tenant and application, so for sure you already had one before, then click on the "Existing app" radio button and select the corresponding app
   
5. Click "Submit request"
6. Once the request is submitted, it may require some time for approval

App name: We highly recommend to name the app in the format of [tenant's full domain]#[application name]. For example:
abc.vincere.io#chatbot
backend-developer.vincere.io#mobile

🔑 Step 5: Get Your API Key
Once your subscription is approved:

1. Hover to your name at the top right corner and go to My Dashboard > My apps
2. Click on the name of the corresponding app
3. The app details page will be displayed
4. The API key is labelled as auth token and located in the section Access and Credentials Info

Your API key is ready — copy and store it securely.

✅ Step 6: Start Using the API
You’re all set! Use your API key by including it in your requests, typically via a header:

x-api-key: <your API Key>