About the SuperOffice category

Alumio_Bot · September 21, 2022, 11:14am

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

Extra information

System documentation: SuperOffice REST API v1 | SuperOffice Docs

Connector package documentation

1. Setting up HTTP Client SuperOffice

1.1 Steps

Before we begin, please make sure that our Oauth redirect URL (Settings > Info > Environment > 0Auth Redirect URL) is whitelisted in your SuperOffice system.
In the Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select the SuperOffice HTTP Client as the prototype for the HTTP Client.
Fill in the Environment, Customer ID, Client ID, and Client Secret. (For more information, see SuperOffice Authentication Guide). Alumio uses interactive authentication to connect.
Click “Grant Access to SuperOffice”.
Fill in the username and password in the newly opened tab, then proceed.
The key will show up when you get back into Alumio Dashboard.
Save the HTTP Client for use.

2. Subscribing to Entities from SuperOffice

2.1 Steps

Go to Connections → Incoming, create a new incoming configuration, and select SuperOffice Subscriber as the subscriber.
Select the entity you want to subscribe to from SuperOffice.
Add any request parameters needed to subscribe to the entity (optional).
You can optionally add a transformer to transform the request parameters into something you will request from SuperOffice.
Select the SuperOffice HTTP Client to use.

2.2 General Concept

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

Entity

It’s the entity you want to subscribe to from SuperOffice. Please refer to the entities from the SuperOffice API Reference page.

Request Parameters

You can provide these parameters to get the needed entity based on the SuperOffice API Reference. Please look at the example below on how to fill Request Parameters when subscribing to “Gets an AppointmentEntity object.”

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

We can refer to how SuperOffice defines the endpoint in their documentation:

That is how we set the id in the path. It will be sent to SuperOffice as /Appointment/1 from Alumio

Input Transformer

Any transformer’s set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and manipulate 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 you will use to access SuperOffice.

3. Publishing Entity to SuperOffice

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select SuperOffice Publisher as the publisher.
Select the action that you want the publisher to perform with the data.
Select the SuperOffice entity you want the data to be published to.
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.
You can optionally add any path data to the request on the key path.
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). However, you can also add or modify payload using the Request Transformer.

Action

Currently, we support HTTP Post method, HTTP Put method, HTTP Patch, and HTTP Delete method.

Entity

Please refer to the entities from SuperOffice API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For example, we want to Update a Contact. Please select “Put” as the action and “Update the existing ContactEntity” as the entity of the publisher.

You can put the payload you want to send to SuperOffice into the payload key in the data. And you need to specify a path key called “id” with the contact id you want to update, such as below.

Alumio will send an API request to SuperOffice with PUT method and URL of /api/v1/Contact/611

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