About the Zoho Creator category

[Alumio_Bot]

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

Extra information

System documentation: ZOHO Creator API Reference

Connector package documentation

Table of Contents

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

1. Setting up HTTP Client ZOHO Creator

1.1 Steps

1. Please refer to this page to register Microsoft Dynamics 365 Finance & Operations to Azure Active Directory. Follow the guide and save the tenant ID, client ID, and client secret of the app registration.
2. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
3. Select ZOHO Creator HTTP Client as PlatForm and click the next step
4. Fill in the Base URI, Client ID, and Client Secret of your ZOHO Creator instance and app credentials.
5. You can optionally set a base HTTP client to use for the connection by selecting an HTTP client configuration or setting your own HTTP client in the Advanced HTTP client field
6. Click the Grant access to ZOHO Creator button to get the access token.
7. You can optionally change how Alumio logs every HTTP request made by the HTTP client
8. Click the 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 ZOHO Creator

2.1 Steps

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

2.2 General Concept

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

Entity

It’s the entity you want to do (fetching data from ZOHO Creator). Please refer to the ZOHO Creator API Reference page.

Request Parameters
These are the parameters you can provide to get the needed entity based on Zoho Creator API
Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity

That’s why we need to define the account_owner_name, app_link_name, report_link_name, record_ID
property inside path property in the Request Parameters field. 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 coupon entity.
/api/v2/alumiotest/order-management/report/All_Orders

Input Transformer

Any transformers set here will be executed after the Request Parameters are loaded. So, you 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

The HTTP Client configuration you will use to access ZOHO Creator.

3. Publishing Entity to ZOHO Creator

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration, and select “ZOHO Creator Publisher” as the publisher.
2. Select the Method you want the publisher to use with the data.
3. Select the ZOHO Creator entity to which the data will be published.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. 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 the payload using the Request Transformer.

Action

Currently, we support Create (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH
method), and Delete (HTTP DELETE method).

Entity

We support publishing to most Zoho Creator endpoints but not with publishing binary files at the
moment. Please refer to the entities in Management APIs from Zoho Creator API Reference page.
Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require object as the request payload, please look at the example below. For
example, we want to Delete a Product. Please select “Delete” as the action and “Assets” as the entity of the publisher.

You can put the payload you want to send to Zoho Creator into the payload property in the data. Here is an example of the Possible Response after Creation.

Alumio will send an API request to Zoho Creator with URL /products/123

HTTP Client

It’s the HTTP Client configuration or prototype that you will use to access ZOHO Creator.