Orisha

​

Extra information

System documentation: Orisha API Reference

​

Connector package documentation

​

Table of Contents

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

​

1. Setting up HTTP Client

1.1 Steps

1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client.
2. Select Orisha HTTP Client as Platform and click Next Step
3. Fill in the Base URL, Client ID, Client Secret, API Key, Access token URL and Audience.
4. You can optionally enable logging of requests to get the log of the HTTP requests.
5. Click next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use.

​

2. Subscribing to Entities from Orisha

2.1 Steps

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

2.2 General Concept We follow the Orisha documentation on building this connector, so you can easily use the connector. Entity The entity you want to subscribe to Orisha. Please refer to the entities from Orisha API Reference page. Request Parameters You can provide these parameters to get the needed entity based on the Orisha API Reference. Please look at the example below on how to fetch all items by subscribing to the “List Items by skip & take” entity. From the endpoint, we can see that we need to set the database id as a parameter. That is why we set the “skip” and “take” inside the query key in the Request Parameters. Alumio will then make a request to Orisha with the URL https://api.core-suite.io?skip=0&take=10

• Path is the path parameter of the URL.
• A query is a defined set of parameters attached to the end of a URL.
  Example: www.url.com?skip=0&take=10

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

​

3. Publishing Entity to Orisha

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration, and select “Orisha Publisher” as the publisher.
2. Select the HTTP Client to use.
3. Select the Method you want the publisher to use with the data.
4. Select the entity you want the data to be published to.
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.

3.2 General Concept Like the subscriber, the publisher has similar methods for using 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 the payload using the Request Transformer. Method Currently, we support the HTTP Post, Put, and Delete method on submitting data to Orisha. Entity We support publishing to all Orisha endpoints. Please refer to the Orisha API Reference For example, we want to update a profile. Please select “Post” as the Method and “Create a Webhook”. From the documentation, we can see that we need to set a body parameter. That is why we see body parameters inside the payload key in the data. Alumio will send an API request to Orisha with URL POST https://api.core-suite.io/v1/webhooks with the defined payload.

• 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
• Payload is the data contained within a request.

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