Use Virtrex API & Webhook
1. What are an API and a webhook?
API (Application Programming Interface) is an interface through which a system can communicate with other programs or applications. Through the REST API, Virtrex offers the possibility of linking other software services such as ERP, CRM or PIM. The advantage is that data can be pulled from Virtrex and processed in any other system, and vice versa.
Webhooks enable one-way communication between applications. The webhook plays a response to the external system when a certain action is performed.
2. Fields of application in Virtrex
Due to the REST API, records in Virtrex can be created, read, edited and deleted using external services. Please note that these functionalities may differ depending on the area which the record is assigned to. For more detailed information, please refer to our API documentation (see below image 1.2.).
You can select the functionality of the webhooks directly in Virtrex. Detailed information can be found in section 4. Please note that the set actions take place at brand level and they are currently not implementable for a single Expo. For more detailed information, please refer to our webhook documentation.
3. API key
In order to generate an API key in your Virtrex Admin Panel, you need the appropriate rights. If you have them, go to the left menu bar of your Admin Panel to “Settings”, open the “API Integration” section and click “Create new API key” (see below image 1.1.). Please enter a name for the new API key that can be clearly assigned to its function. After creating the API key, you can copy it using the icon on the right and reuse it respectively.
Image 1: Under “API integration” you can create a new API key or resolve existing connections.
Please note that the API key is only issued once so that multiple use can be precluded.
3.1 Deactivate API key
If you no longer need an API connection, you can delete the corresponding API key under “API Tokens”. In order to do this, click on the icon to the right of the corresponding key (see above image 1.3.). By deleting it, all established interfaces are removed and the functionalities are discontinued with immediate effect.
3.2 API key security
Please note that an API key provides full access to your Virtrex account and therefore should be protected in the best possible way. To protect the key, we would like to provide you with the following security advice:
Assign each API integration its own API key which is given its own name. The name should correspond to the integration so that if you deactivate it, you can delete the corresponding API key without affecting other integrations.
Never share your API key publicly and only with authorized employees.
Never send an API key via e-mail or hackers will gain access to your records in case of an attack.
Once your brand’s account is deleted, all associated APIs and webhooks are removed.
4. Webhook integration
In order to be able to perform the webhook integration, you need the appropriate rights. If you have them, go to the left menu bar of your admin panel to “Settings”, open the “Webhook Integration” section and click “Create New Webhook”. After you have entered your target URL, a new window will open where you can make further settings. The functionalities provided by the webhook are predefined by Virtrex (see below image 2).
Image 2: Here you can see how to create a webhook.
Please note that depending on the external system a password entry is necessary (see above image 2).
5. Good to know
Linking an API or webhook to your software services requires system administrative support within your organization.