Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: [Ocoya API Reference]
Ocoya
Connector Package Documentation
Setting up HTTP Client Ocoya
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Ocoya HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, Client ID, and Client Secret (Token URL and Authorize are set on Default).
- Press, Grant access to Ocoya and Key will be retrieved.
- Save the Client for use later.
Subscribing to Entities from Ocoya
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Ocoya Subscriber as the subscriber.
- Select the entity you want to subscribe from Ocoya .
- 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 need.
- Select the Ocoya HTTP Client to use.
General Concept
We follow Ocoya documentation on building this connector so you can easily use the connector based on Ocoya API Reference.
Method
It’s the Method you want to subscribe from Ocoya. Based on the Method, the Entity will change. Please refer to the entities in Management APIs from Ocoya API Reference page.
Entity
It’s the entity you want to subscribe from Ocoya . Please refer to the entities in Management APIs from Ocoya API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Ocoya API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get schedules.
The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get schedules.
/api/_public/v1/schedules
Input Transformer
Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform 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 or prototype you will use to access Ocoya .
Publishing Entity to Ocoya
Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select Ocoya Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the Ocoya entity you want the data to be published.
- You can optionally add any query parameters to the request.
- You can also optionally add any transformers to transform the data into anything you need before submitting it to Ocoya .
- Select the HTTP Client to use.
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 Post (HTTP POST method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method).
Entity
We support publishing to most Ocoya endpoints. Please refer to the entities in Management APIs from the Ocoya API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create an AI copy. Please select “Post” as the action and “Create an AI copy using our templates” as the entity of the publisher.
You can put the payload you want to send to Ocoya into the payload property in the data.
Alumio will send an API request to Ocoya with URL /api/_public/v1/copy
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Ocoya .