VCOM Cloud
VCOM Cloud
Breadcrumbs

VCOM API

Last modified:


About the VCOM API

The VCOM API enables you to integrate VCOM data with other systems, e.g. to query measured data or ticket statistics. Access to the VCOM API requires an API key as well as credentials to VCOM. 

  • Some resources are read-only, others can be created or modified.

  • Only measured data can be sent via the API, not images.

  • You can only create API keys at the Portfolio level.

See the VCOM API documentation for further details. You can also access the documentation via VCOM: go to the footer and select icon-question5.png Help > icon-github1.png Developer space.


📗

Tips

  • PREMIUM PARTNERS We recommend setting up a dedicated user for API access to enhance security and facilitate tracking. See Create a user-defined user group.

  • Store credentials and API keys securely.

  • Monitor your API usage to stay within plan limits.

  • Consider using JSON format for easier data parsing.

  • Implement proper error handling in your code.

Set up the VCOM API

Prerequisites

  • You are an existing VCOM partner.

Steps

  1. In VCOM at the portfolio level , go to icon-cog1(1).png Administration > icon-equalizer1.png Administration > VCOM API.

  2. If you do not already have an API key, enter a description of your API.

  3. Select the API plan that applies to you. This refers to the number of API calls/requests you are permitted per day.

  4. Select icon-plus-circle2.png Create paid API key. The key will be charged to your account.

The table will display the details for each key you have purchased. You can now use the API keys, for example for authentication.


image-20251112-145116.png
Set up the VCOM API

Locate your VCOM API key

Prerequisites

  • You have already set up the VCOM API.

Steps

  1. In VCOM at the portfolio level , go to icon-cog1(1).png Administration > icon-equalizer1.png Administration > VCOM API.

  2. In the table of API keys, locate the relevant API key.

  3. Copy the API key.

You can now use the key.