About the Exact Globe category

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Exact Globe - Alumio API Plugin API Reference

Connector package documentation

​​Table of Contents

  • 1. Setting up HTTP Client Exact Globe - Alumio API Plugin
    • 1.1 Steps
  • 2. Subscribing to entities from Exact Globe - Alumio API Plugin
    • 2.1 Steps
    • 2.2 General concept
  • 3. Publishing entity to Exact Globe - Alumio API Plugin
    • 3.1 Steps
    • 3.2 General concept

1. Setting up HTTP Client Exact Globe - Alumio API Plugin

1.1 Steps

  1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Exact Globe - Alumio API Plugin HTTP Client as the HTTP Client.
  2. Fill in the Base URL and API Key.
  3. You can optionally enable logging of request to get the log of the authentication.
  4. Save the HTTP Client for use.

2. Subscribing to Entities from Exact Globe - Alumio API Plugin

2.1 Steps

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

2.2 General Concept

We follow Exact Globe - Alumio API Plugin documentation on building this connector, so you can easily use the connector based on Exact Globe - Alumio API Plugin API Reference.

Entity

The entity you want to subscribe to Exact Globe - Alumio API Plugin. Please refer to the entities from Exact Globe - Alumio API Plugin API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Exact Globe - Alumio API Plugin API Reference.

Please look at the example below on how to fill path field when subscribing “Retrieve an item by Id.” entity.

Based on the documentation, we can see that the end point require “Id” as a path. That is why we set the “Id” inside the path key in the Request Parameters.

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

Alumio will then make a request to Exact Globe - Alumio API Plugin with the URL /api/Item/ById/1

HTTP Client

The HTTP Client configuration you will use to access Exact Globe - Alumio API Plugin.

3. Publishing Entity to Exact Globe - Alumio API Plugin

3.1 Steps

  1. Go to Connections → Outgoing, create a new outgoing configuration and select “Exact Globe - Alumio API Plugin Publisher” as the publisher.
  2. Select the Method that you want the publisher to perform with the data.
  3. Select the Exact Globe - Alumio API Plugin entity you want the data to be published to.
  4. You can optionally add any path data to the request on the key path.
  5. You can optionally add any query data to the request on the key query.
  6. You can optionally add any payload data to the request on the key payload.
  7. 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 and HTTP PUT method on submitting data to Exact Globe - Alumio API Plugin.

Entity

We support publishing to most Exact Globe - Alumio API Plugin endpoints.
Please refer to Exact Globe - Alumio API Plugin API Reference page.

For example, we want to create a new Sales Order. Please select “POST” as the Method and “Create a new SalesOrder” as the entity of the publisher.

Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data.

Alumio will send an API request to Exact Globe - Alumio API Plugin with URL /api/SalesOrder

  • 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 Exact Globe - Alumio API Plugin.