Feature Availability
Who can create a Function API?
By default, only the network admins can create a Function API. However, if allowed, selected users can also create a Function API.
How do I create a Function API configuration?
- Click the gear icon [] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, click Function API under Developer Space.
- In the new page, click Create Configuration.
- In the Configuration Details page, give a name, icon, and description.
- Click Save & edit code.
- Write a custom function to define how the request should be handled in the respective handlers.
- Once done, click Expand next to API endpoint.
- Click Generate URL.
- Copy the URL and paste it in the other application from which the request is constructed.
User can create a maximum of 20 Function API configurations each.
How do I edit a Function API configuration?
- Click the gear icon [] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, click Function API under Developer Space.
- From the list of configurations, select the required one.
- In the Configuration Details pop-out, click Edit Configuration.
- Make the required edits and click Save.
How do I disable or delete a Function API configuration?
Disabling the Function API will suspend it temporarily. To disable, follow the steps below:
- Click the gear icon [] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, click Function API under Developer Space.
- From the list of configurations, select the required one.
- To disable the configuration, toggle the button in the top-right corner of the Configuration Details pop-up.
- To delete the configuration, click the trash icon [] in the top-right corner of the Configuration Details pop-up.
Disable the Function API configuration while making changes to the handler code to prevent unwanted invocation.
Execution Logs
The logs in each Function API configuration lists the details of every request handler execution and its results for the past one year. The details include execution time, status, parameters passed, and the data returned by the function. These logs can be used to analyze and debug issues in the API execution.
To view logs:
- Click the gear icon [] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, select Function API under Developer Space.
- From the list of configurations, select the required one.
- In the Configuration Details pop-out, click Edit Configuration.
- Scroll down to the bottom of the page and click Expand next to Logs.
Execution Limit
There is a limit on the number of API executions that are made in a network per day. This limit differs with each subscription plan and can be increased by either upgrading to a higher plan or contacting the Zoho Connect support team. Once you have exhausted the maximum limit, all Function APIs in your network will stop working for the rest of the day and, they will resume functioning by 12.00 AM based on your network's data center location.
To view the execution details:
- Click the gear icon [] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, select Function API under Developer Space.
- You'll see the usage details in the top-right corner of the page.