​

Extra information

System documentation:

​

Connector package documentation

​

Setting up HTTP Client Vplan

​

Steps

1. In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select Vplan HTTP Client as the prototype of the HTTP Client.
2. Fill in the Base URI, Authentication Type, and choose between API-Key or Oauth2.
3. Save.

• If API-Key, fill in the X-Api-Env and X-Api-Key,
• If Oauth2, fill in the Client Id and Client Secret, and Press “Grant access to Vplan CRM”

​

Subscribing to Entities from Vplan

​

Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select Vplan Subscriber as the subscriber.
2. Select the entity you want to subscribe from Vplan.
3. Add any request parameters needed to subscribe to the entity (optional).
4. You can optionally add a transformer to transform the request parameters into something you need.
5. Select the Vplan HTTP Client to use.

​

General Concept

We follow Vplan documentation on building this connector so you can easily use the connector based on Vplan API Reference. Entity It’s the entity you want to subscribe from Vplan. Please refer to the entities in Management APIs from Vplan API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on Vplan API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity That’s why we need to define board_id property inside path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Single Board Entity. /v1/board/ 4566d4f4-c0fa-4c72-a0ec-4e208affaaf5 Input Transformer Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration or prototype you will use to access Vplan.

​

Publishing Entity to Vplan

​

Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration and select Vplan Publisher as the publisher.
2. Select the action that you want the publisher to do with the data.
3. Select the Vplan entity you want the data to be published to.
4. Select the HTTP Client to use.

​

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). Action Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). Entity We support publishing to most Vplan endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Vplan API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create New Board. Please select “Create” as the action and “Create New Board” as the entity of the publisher. You can put the payload you want to send to Vplan into payload property in the data. Here is an example of the Possible Response after Creation. Alumio will send an API request to Vplan with URL /v1/board HTTP Client It’s the HTTP Client configuration or prototype you will use to access Vplan.