ManageEngine

​

Extra information

System documentation: ManageEngine API Reference

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client ManageEngine
  • 1.1 Steps
• 2. Subscribing to entities from ManageEngine
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to ManageEngine
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client ManageEngine

1.1 Steps

1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client.
2. Select ManageEngine HTTP Client as PlatForm and click next step
3. Fill in the Base URI, Token URL, Authorize URL, Client ID, Client Secret and Scopes. (See the ManageEngine Authentication Documentation for more information)
4. Click on “Grant access to ManageEngine” and you will be redirected to ManageEngine page to get the key for the client.
5. You can optionally enable logging of request to get the log of the authentication.
6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

​

2. Subscribing to Entities from ManageEngine

2.1 Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select “ManageEngine Subscriber” as the subscriber.
2. Select the entity you want to subscribe to from ManageEngine.
3. Add any request parameters needed to subscribe to the entity.
4. Select the ManageEngine HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from ManageEngine.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept We follow ManageEngine documentation on building this connector, so you can easily use the connector based on ManageEngine API Reference. Entity The entity you want to subscribe to ManageEngine. Please refer to the entities from ManageEngine API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on the ManageEngine API Reference. Please look at the example below on how to fill path field when we want retrieve a product by subscribing “Admin - Get Product” entity. From the end point, we can see that we need to set the product id as parameters. That is why we set the “product_id” inside the path key in the Request Parameters. Alumio will then make a request to ManageEngine with the URL api/v3/products/218291000000292605

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url. Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client The HTTP Client configuration you will use to access ManageEngine.

​

3. Publishing Entity to ManageEngine

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration and select “ManageEngine Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the ManageEngine entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 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), though you can also add or modify payload using the Request Transformer. Method Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to ManageEngine. Entity We support publishing to most ManageEngine endpoints. Please refer to ManageEngine API Reference page. For example, we want to edit a product. Please select “Put” as the Method and “Admin - Edit Product”. From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the “product_id” inside the path key and body parameters inside the payload key in the data. ManageEngine require us to send the payload in serialized JSON please refer to https://forum.alumio.com/t/how-to-use-value-mapper/290 for more information about serializing a JSON. Please be aware to set “Advanced” -> “Request Encoder” at “Form URL encoded” when sending payload to ManageEngine. Alumio will send an API request to ManageEngine with URL api/v3/products/218291000000292605

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client The HTTP Client configuration you will use to access ManageEngine.