About the InRiver category

Alumio_Bot · September 21, 2022, 10:01am

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

Extra information

System documentation: InRiver API Reference

Connector package documentation

1. Setting up HTTP Client InRiver

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “InRiver HTTP Client” as the HTTP Client.
Fill in the Base URL and API Key.
(For more information, see InRiver Reference)
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from InRiver

2.1 Steps

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

2.2 General Concept

We follow InRiver documentation on building this connector, so you can easily use the connector based on InRiver API Reference.

Entity

The entity you want to subscribe to InRiver. Please refer to the entities from InRiver API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the InRiver API Reference.

Please look at the example below on how to fill path field when subscribing “GetChannelsForEntityId” entity.

Based on the documentation, we can see that the end point has optional query parameters. That is why we can set the “forEntityId”, “includeChannels” and “includePublications” inside the query 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 InRiver with the URL /channels?forEntityId=1&includeChannels=true&includePublications=true

HTTP Client

The HTTP Client configuration you will use to access InRiver.

3. Publishing Entity to InRiver

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “InRiver Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the InRiver entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
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 InRiver.

Entity

We support publishing to most InRiver endpoints.
Please refer to InRiver API Reference page.

For example, we want to delete a link. Please select “DELETE” as the Action and “Delete Link” as the entity of the publisher.

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

Alumio will send an API request to InRiver with URL /links/123

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.